openstack/openstack-manuals
Code Issues Proposed changes
OpenStack Manuals
153 Commits 4 Branches 2 Tags 474 MiB
HTML 77.7%
CSS 12.6%
Python 4.9%
JavaScript 3.4%
Shell 1.4%
3aad9dbe45
Go to file
Tyler North 3aad9dbe45 bug 923273 edited the url 
Change-Id: I5648716e3f6c2b55c20715bfd16b337cb8bf93af
2012-03-08 14:25:31 -08:00
doc bug 923273 edited the url 2012-03-08 14:25:31 -08:00
tools Add rfc.sh to help with gerrit workflow. 2011-09-15 15:03:40 -07:00
www Use 3 columns instead of 2 + wall of text 2012-03-06 00:23:59 +00:00
.gitignore standardize capitalization: ReST -> REST 2012-02-29 23:18:48 -08:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 14:52:07 -04:00
README.rst Update the formatting of README 2012-03-06 15:34:54 -08:00

README.rst

Openstack Manuals

This repository contains the cloud administrator documentation for the OpenStack project. It includes documentation for:

  • OpenStack Compute
  • OpenStack Identity Service
  • OpenStack Image Service
  • OpenStack Object Storage
  • OpenStack Dashboard

For more details, see the OpenStack Documentation HowTo wiki page.

In addtion to the guides, this repository contains:

  • api.openstack.org: doc/src/docbkx/openstack-api-site
  • docs.openstack.org: www

Prerequisites

Apache Maven must be installed to build the documentation.

To install Maven for Ubuntu:

apt-get install maven2

Building

To build the Compute Admin Manual, Object Storage Admin Manual, and Image Service Manual:

cd openstack-manuals/doc
mvn clean generate-sources

The different manuals are in subdirectories of the openstack-manuals/doc/src/docbkx directory.

For example, the root directory of the OpenStack Compute Administration Guide is openstack-manuals/doc/src/docbkx/openstack-compute-admin.

To build a specific guide, look for a pom.xml file within a subdirectory, then run the mvn command in that directory. For example:

cd openstack-manuals/doc/src/docbkx/openstack-compute-admin
mvn clean generate-sources

The generated PDF documentation file is:

openstack-manuals/doc/src/docbkx/openstack-compute-admin/target/docbkx/webhelp/trunk/openstack-compute/admin/os-compute-adminguide-trunk.pdf

The root of the generated HTML documentation is:

openstack-manuals/doc/src/docbkx/openstack-compute-admin/target/docbkx/webhelp/os-compute-adminguide/content/index.html

Contributing

Our community welcomes all people interested in open source cloud computing, and there are no formal membership requirements. The best way to join the community is to talk with others online or at a meetup and offer contributions through Launchpad, the OpenStack wiki, blogs, or on IRC at #openstack on irc.freenode.net.

We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.

Installing

Refer to http://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.