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
- OpenStack Network Connectivity
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
Apache Maven must be installed to build the documentation.
To install Maven for Ubuntu:
apt-get install maven3
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:
The root of the generated HTML documentation is:
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.
Refer to http://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.