Jump to: navigation, search

Difference between revisions of "Documentation"

Line 1: Line 1:
= [[OpenStack]] software documentation =
= [[OpenStack]] software documentation =

Revision as of 21:00, 16 February 2013

OpenStack software documentation

Documentation is community-oriented and available for different audiences on several websites - this wiki is for fast, changing documentation, the developer documentation for the projects is on nova.openstack.org, swift.openstack.org, keystone.openstack.org, and glance.openstack.org. For official documentation, see docs.openstack.org. To log a bug against the documentation, go to http://bugs.launchpad.net/openstack-manuals.

There's also an OpenStack documentation mailing list.

<<Columns(2, start)>>

OpenStack Manuals

OpenStack APIs


  • OpenStack Compute Administration Manual html pdf
  • OpenStack Object Storage Administration Manual html pdf
  • OpenStack Network Administration Manual (Quantum) html pdf

Source Repositories

Doc source is on GitHub. Everyone can propose merge to docs. Here are the repositories that build to docs.openstack.org.


These guides are available and sourced in .rst files in /doc/source/ if you want to work on them:

Ideally the content on the above sites is geared towards developers, and docs.openstack.org is for developer consumers of the ReST API and OpenStack administrators.


Lists current development release and past releases, with links to downloads and release notes (what's new and what's changed in each release as well as known issues and potential workarounds)


How to install either Swift or Nova.


How to find or ask for support.


  • Glossary - Contains terms that are our definitions for OpenStack, cloud computing, and open source.


Project documentation


How to contribute code to OpenStack or develop using the OpenStack projects.

Launchpad reference

How we use Launchpad to track features, bugs and releases.

Writing documentation

<<Columns(2, end)>>