OpenStack Manuals

Go to file

Maxime Guyot c2e9f33589 Disable HTTP redirection for subdir of /deploy/ Change-Id: I0f7ba59e052d875ae17e56fc83ef19f888994b5d Closes-Bug: #1727791		2017-10-27 11:42:11 +02:00
doc	[contrib] Rename special*ty teams to subteams	2017-10-25 18:53:05 +02:00
playbooks/build-manuals-tox	Add native zuulv3 set up	2017-10-09 22:07:27 +02:00
releasenotes/source	Imported Translations from Zanata	2017-10-04 16:06:17 +00:00
tools	Raise on init, parse, render, or write fails	2017-10-22 16:18:30 -05:00
www	Disable HTTP redirection for subdir of /deploy/	2017-10-27 11:42:11 +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
.zuul.yaml	Add publish jobs to Zuul v3 configuration	2017-10-10 20:19:40 +02:00
bindep.txt	Add gcc requirement to bindep.txt	2017-10-03 13:41:01 +00:00
CONTRIBUTING.rst	[contrib-guide] Updating url to doc-contrib-guide	2017-09-22 14:57:47 +00:00
doc-tools-check-languages.conf	[contrib-guide] Updating url to doc-contrib-guide	2017-09-22 14:57:47 +00: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	Remove obsolete guides from README.rst	2017-10-26 13:08:31 +02:00
test-requirements.txt	use whereto to test redirect rules	2017-08-25 18:56:14 -04:00
tox.ini	make checkniceness an alias for linters in tox	2017-10-09 10:04:06 -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

Documentation Contributor Guide

High Availability Guide

Installation 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 linters - 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.