OpenStack Manuals

Go to file

Gauvain Pocentek 77ff96074a config-ref: glance tables update Change-Id: Idc0de341dce591a4d675d1ae2c7abd99cb10af2e		2015-04-24 15:08:01 +02:00
.tx	Fix .tx/config	2015-04-22 16:24:04 +02:00
doc	config-ref: glance tables update	2015-04-24 15:08:01 +02:00
tools	config-ref: glance tables update	2015-04-24 15:08:01 +02:00
www	Simplify User Guide redirects	2015-04-23 19:58:27 +02:00
.gitignore	Add RST Glossary	2015-04-14 19:57:35 +00:00
.gitreview	Add .gitreview config file for gerrit.	2011-10-24 14:52:07 -04:00
doc-test.conf	Fix url_exception argument to ignore URL	2015-04-18 18:45:53 +02:00
doc-tools-check-languages.conf	Networking: Setup translation for RST	2015-04-19 19:15:32 +02:00
LICENSE	bug 944097 adding apache license to openstack-manuals repo	2012-03-09 08:37:46 -06:00
projects.txt	Don't sync to training-guides	2015-01-28 09:31:35 +00:00
README.rst	Update Guides in README	2014-10-29 08:48:25 +01:00
test-requirements.txt	Updated from global requirements	2015-04-23 21:53:01 +00:00
tox.ini	Reenable some doc8 tests	2015-04-21 16:32:06 +02:00

README.rst

OpenStack Manuals

This repository contains documentation for the OpenStack project.

For more details, see the OpenStack Documentation wiki page.

It includes these manuals:

Admin User Guide

Architecture Design Guide

Cloud Administrator Guide

Command-Line Interface Reference

Configuration Reference

End User Guide

Heat Orchestration Template reference

HOT Guide

Installation Guides

Virtual Machine Image Guide

In addition to the guides, this repository contains:

docs.openstack.org: www

Prerequisites

Apache Maven must be installed to build the documentation.

To install Maven 3 for Ubuntu 12.04 and later, and Debian wheezy and later:

apt-get install maven

On Fedora 20 and later:

yum install maven

On openSUSE 13.1 and later:

zypper ar http://download.opensuse.org/repositories/devel:/tools:/building/openSUSE_13.1/devel:tools:building.repo
zypper install maven

Building

The different manuals are in subdirectories of the openstack-manuals/doc/ directory.

For example, the root directory of the OpenStack User Guide is openstack-manuals/doc/user-guide.

To build a specific guide, look for a pom.xml file within a subdirectory, then run the mvn command in that directory. For example:

cd openstack-manuals/doc/user-guide/
mvn clean generate-sources

The generated PDF documentation file is:

openstack-manuals/doc/user-guide/target/docbkx/webhelp/user-guide.pdf

The root of the generated HTML documentation is:

openstack-manuals/doc/user-guide/target/docbkx/webhelp/user-guide/content/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 checklinks - to run the tests for working remote URLs

tox -e checkniceness - to run the niceness tests

tox -e checksyntax - to run syntax checks

tox -e checkdeletions - to check that no deleted files are referenced

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 Documentation HowTo.

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.