OpenStack Manuals

Go to file

Andreas Jaeger 8252e28627 [www] Avoid duplicate contributor-guides id We used the id twice, fix this. Change-Id: I0a40402f5317c04d23f33cb54afc81e703421753		2017-09-08 17:26:13 +02:00
doc	Merge "[contributor] Fix docs-builds rendering"	2017-09-07 14:24:19 +00:00
releasenotes/source	Release note entries for Security Guide	2017-08-30 14:26:34 +01:00
tools	use whereto to test redirect rules	2017-08-25 18:56:14 -04:00
www	[www] Avoid duplicate contributor-guides id	2017-09-08 17:26:13 +02:00
.gitignore	Cleanup .gitignore	2017-07-21 20:26:29 +02:00
.gitreview	Add .gitreview config file for gerrit.	2011-10-24 14:52:07 -04:00
.pydevproject	[config-ref] Update api-paste.ini of manila	2017-04-13 19:38:07 +08:00
bindep.txt	Simplify conf.py for openstackdocstheme 1.11.0	2017-06-27 07:04:30 +02:00
CONTRIBUTING.rst	Use https instead of http for openstack sites	2017-01-31 07:36:48 +09:00
doc-tools-check-languages.conf	Build additional tr_TR guides	2017-08-22 09:34:13 +02:00
LICENSE	bug 944097 adding apache license to openstack-manuals repo	2012-03-09 08:37:46 -06:00
projects.txt	Stop syncing common to api-site/first-app	2017-02-11 22:04:19 +09:00
README.rst	Update links in README	2017-08-15 10:08:14 +08:00
test-requirements.txt	use whereto to test redirect rules	2017-08-25 18:56:14 -04:00
tox.ini	use whereto to test redirect rules	2017-08-25 18:56:14 -04:00

README.rst

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

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

Some pre-requisites are needed to build the guides. If you are using a Linux operating system you can generate a report of missing local requirements with the bindep command:

$ tox -e bindep

All guides are in the RST format. You can use tox to prepare virtual environment and build all guides (HTML only):

$ tox -e docs

You can also build a specific guide.

For example, to build OpenStack Virtual Machine Image Guide, use the following command:

$ tox -e build -- image-guide

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

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

To build a specific guide with a PDF file, add a -pdf option like:

$ tox -e build -- image-guide --pdf

The generated PDF file will be copied to the root directory of the generated HTML documentation.

If you get this message make: xelatex: No such file or directory it means your local environment does not have LaTeX installed. Read Getting LaTeX for instructions.

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 the OpenStack CI 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.