OpenStack Manuals
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
KATO Tomoyuki 79aa72b0cb
[image-guide] Publish RST Vitual Machine Image Guide
7 years ago
doc [image-guide] Publish RST Vitual Machine Image Guide 7 years ago
tools [image-guide] Publish RST Vitual Machine Image Guide 7 years ago
www [image-guide] Publish RST Vitual Machine Image Guide 7 years ago
.gitignore Revert "Add reno for release-notes" 7 years ago
.gitreview Add .gitreview config file for gerrit. 12 years ago
LICENSE bug 944097 adding apache license to openstack-manuals repo 11 years ago
README.rst Update RST build instructions in README 8 years ago
RELEASENOTES.rst [image-guide] Publish RST Vitual Machine Image Guide 7 years ago
doc-test.conf New nova policy.json sample 8 years ago
doc-tools-check-languages.conf [image-guide] Publish RST Vitual Machine Image Guide 7 years ago
projects.txt Copy RST files to ha-guide and api-site 8 years ago
test-requirements.txt Revert "Add reno for release-notes" 7 years ago
tox.ini Revert "Add reno for release-notes" 7 years ago


OpenStack Manuals

This repository contains documentation for the OpenStack project.

For more details, see the OpenStack Documentation wiki page.

It includes these manuals:

  • Admin User Guide
  • Architecture Design Guide
  • Cloud Administrator Guide
  • Command-Line Interface Reference
  • Configuration Reference
  • End User Guide
  • Heat Orchestration Template reference
  • HOT Guide
  • Installation Guides
  • Virtual Machine Image Guide

In addition to the guides, this repository contains:

  • www


Apache Maven must be installed to build the documentation.

To install Maven 3 for Ubuntu 12.04 and later, and Debian wheezy and later:

apt-get install maven

On Fedora 20 and later:

yum install maven

On openSUSE 13.1 and later:

zypper ar
zypper install maven


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

DocBook guides

For example, the root directory of the OpenStack Virtual Machine Image Guide is openstack-manuals/doc/image-guide.

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/image-guide/
mvn clean generate-sources

The generated PDF documentation file is:


The root of the generated HTML documentation is:


RST guides

Then, you can see some guides written in the RST format, so we can't use mvn command. You can use tox to prepare virtual environment and build all RST based guides:

tox -e docs

You can also build a specific guide. For example, to build OpenStack End User Guide, use the following command:

tox -e build -- user-guide

You can find the root of the generated HTML documentation at:


Testing of changes and building of the manual

Install the python tox package and run tox from the top-level directory to use the same tests that are done as part of our Jenkins gating jobs.

If you like to run individual tests, run:

  • tox -e checklinks - to run the tests for working remote URLs
  • tox -e checkniceness - to run the niceness tests
  • tox -e checksyntax - to run syntax checks
  • tox -e checkdeletions - to check that no deleted files are referenced
  • tox -e checkbuild - to actually build the manual
  • tox -e checklang - to build translated manuals

tox will use the openstack-doc-tools package for execution of these tests.


Our community welcomes all people interested in open source cloud computing, and encourages you to join the OpenStack Foundation.

The best way to get involved with the community is to talk with others online or at a meet up and offer contributions through our processes, the OpenStack wiki, blogs, or on IRC at #openstack on

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

If you would like to contribute to the documents, please see the Documentation HowTo.


Bugs should be filed on Launchpad, not GitHub:


Refer to to see where these documents are published and to learn more about the OpenStack project.