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
MikeG451 cf252ea9ac
Add best practices properties to MS Win image example
6 years ago
doc Add best practices properties to MS Win image example 6 years ago
releasenotes/source Merge "[i18n] add translation release notes for Ocata" 6 years ago
tools Merge "[config-ref] update ironic config options for Ocata" 6 years ago
www Merge "Publish Ocata release" 6 years ago
.gitignore Add "*.swo" to ".gitignore" file 7 years ago
.gitreview Add .gitreview config file for gerrit. 12 years ago
CONTRIBUTING.rst Use https instead of http for openstack sites 6 years ago
LICENSE bug 944097 adding apache license to openstack-manuals repo 11 years ago
README.rst Document how to build from old copies of the openstack-manuals repo 6 years ago
bindep.txt [PDF] Liberation font support using xelatex 6 years ago
doc-tools-check-languages.conf [i18n] publish Japanese Ops Guide 6 years ago
projects.txt Stop syncing common to api-site/first-app 6 years ago
test-requirements.txt Switch to current Sphinx 6 years ago
tox.ini Test that glossary is sorted 6 years ago


Team and repository tags


OpenStack Manuals

This repository contains documentation for the OpenStack project.

For more details, see the OpenStack Documentation Contributor Guide.

It includes these manuals:

  • Administrator Guide
  • Architecture Design Guide
  • Command-Line Interface Reference
  • Configuration Reference
  • Documentation Contributor Guide
  • End User Guide
  • High Availability Guide
  • Installation Tutorials
  • Networking Guide
  • Operations Guide
  • Virtual Machine Image Guide

In addition to the guides, this repository contains:

  • contents: www


Various manuals are in subdirectories of the doc/ directory.


All guides are in the RST format. You can use tox to prepare virtual environment and build all 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 checkbuild - to actually build the manual
  • tox -e checklang - to build translated manuals
  • tox -e checkniceness - to run the niceness tests
  • tox -e linkcheck - to run the tests for working remote URLs

The tox command uses the openstack-doc-tools package to run the tests.

Generated files

Some documentation files are generated using tools. These files include a do not edit header and should not be modified by hand. Please see Generated files.


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.