OpenStack Manuals

Go to file

Andreas Jaeger 98c89d2d16 Rename other-requirements.txt -> bindep.txt OpenStack CI has changed the default name for bindep, follow the rename. Change-Id: I410c18658589df803880dab8bc0d41bae185c6a2		2016-08-11 11:09:43 +02:00
doc	Imported Translations from Zanata	2016-08-11 07:04:40 +00:00
releasenotes/source	Imported Translations from Zanata	2016-08-04 07:05:05 +00:00
tools	[network] Add missing sriov-agent config opts	2016-08-05 13:38:53 +00:00
www	Merge "[ops-guide] Changed underscore to hyphen in RST files"	2016-08-11 06:18:56 +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
bindep.txt	Rename other-requirements.txt -> bindep.txt	2016-08-11 11:09:43 +02:00
doc-test.conf	Remove XML file exceptions from doc-test.conf	2016-05-18 21:31:31 +02:00
doc-tools-check-languages.conf	Do not translate debconf install guide for now	2016-06-15 09:53:46 +02:00
LICENSE	bug 944097 adding apache license to openstack-manuals repo	2012-03-09 08:37:46 -06:00
projects.txt	[ha-guide] Changes after ha-guide is merged to manuals	2016-05-05 21:12:50 +05:30
README.rst	just drop the 's' of Installation Guides in README.rst	2016-06-07 17:14:00 +08:00
test-requirements.txt	Require openstackdocstheme 1.4.0	2016-07-20 13:16:21 +02:00
tox.ini	remove unused path from checkniceness ignore-path	2016-07-21 23:52:54 +09:00

README.rst

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 Guide

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 linkcheck - to run the tests for working remote URLs

tox -e checkniceness - to run the niceness tests

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.

Contributing

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 irc.freenode.net.

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 OpenStack Documentation Contributor Guide.

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 http://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.