526b313e76
Allow my docbook editor to reformat this file to its liking before making real changes. Change-Id: Iefede6e2b8213529b6628864dc4afe5bcd7c323b
This repository contains the cloud administrator documentation for the OpenStack project. It includes documentation for OpenStack Compute, OpenStack Identity Service, OpenStack Image Service, and OpenStack Object Storage as well as the Dashboard.
For more details, see the OpenStack Documentation HowTo wiki page.
- In addtion to the guides, this repostiory contains:
-
- api.openstack.org site: doc/src/docbkx/openstack-api-site
- index & resources for docs.openstack.org: www
Prereqs
Apache Maven must be installed to build the documentation.
To install Maven for Ubuntu:
apt-get install maven2Building
To build the Compute Admin Manual, Object Storage Admin Manual, and Image Service Manual:
cd openstack-manuals/doc
mvn clean generate-sourcesThe 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-sourcesThe generated PDF documentation file is:
openstack-manuals/doc/src/docbkx/openstack-compute-admin/target/docbkx/webhelp/trunk/openstack-compute/admin/os-compute-adminguide-trunk.pdfThe root of the generated HTML documentation is:
openstack-manuals/doc/src/docbkx/openstack-compute-admin/target/docbkx/webhelp/os-compute-adminguide/content/index.htmlContributing
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, or blogs. 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.