openstack
/
openstack-manuals
Code Issues Proposed changes
OpenStack Manuals
18,577 Commits 4 Branches 2 Tags 472 MiB
HTML 77.1%
CSS 13%
Python 5%
JavaScript 3.5%
Shell 1.4%
Go to file
Jenkins 472c09aff1 Merge "[install-guide] Minor edits to overview and index.rst" 2017-02-20 14:36:03 +00:00
doc Merge "[install-guide] Minor edits to overview and index.rst" 2017-02-20 14:36:03 +00:00
releasenotes/source Merge "[i18n] add translation release notes for Ocata" 2017-02-20 11:51:14 +00:00
tools Merge "[config-ref] update ironic config options for Ocata" 2017-02-18 14:17:54 +00:00
www Merge "Publish Ocata release" 2017-02-20 11:27:48 +00:00
.gitignore Add "*.swo" to ".gitignore" file 2016-08-09 06:18:46 +00:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 14:52:07 -04:00
CONTRIBUTING.rst Use https instead of http for openstack sites 2017-01-31 07:36:48 +09:00
LICENSE bug 944097 adding apache license to openstack-manuals repo 2012-03-09 08:37:46 -06:00
README.rst Document how to build from old copies of the openstack-manuals repo 2017-02-09 14:47:55 -06:00
bindep.txt [PDF] Liberation font support using xelatex 2017-02-08 12:57:10 +00:00
doc-tools-check-languages.conf [i18n] publish Japanese Ops Guide 2017-02-02 08:04:44 +00:00
projects.txt Stop syncing common to api-site/first-app 2017-02-11 22:04:19 +09:00
test-requirements.txt Switch to current Sphinx 2017-01-13 16:36:45 +01:00
tox.ini Test that glossary is sorted 2016-11-14 16:43:19 +01:00

README.rst

Team and repository tags

image

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:

  • docs.openstack.org contents: www

Building

Various manuals are in subdirectories of the doc/ directory.

Guides

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:

doc/user-guide/build/html/index.html

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

Bugs should be filed on Launchpad, not GitHub:

https://bugs.launchpad.net/openstack-manuals

Installing

Refer to https://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.