openstack
/
ha-guide
Code Issues Proposed changes
OpenStack High Availability Guide
420 Commits 1 Branch 0 Tags 6.2 MiB
Python 100%
Go to file
Meg McRoberts d0aedb0159 set up skeleton files for ha-guide 
This commit creates content-free files.  After it is merged,
we can proceed to add content in separate commits.

All pathnames use hyphens as the space delimiter.

Implements blueprint improve-ha-guide

Change-Id: I87a078883680b2e40959279e29c2d427131097ce
 		2015-05-17 09:58:31 +00:00
doc set up skeleton files for ha-guide 2015-05-17 09:58:31 +00:00
tools Ignore <option> tags in generatepot 2015-01-01 20:32:22 +08:00
.gitignore Add RST infrastructure for HA Guide 2015-05-02 09:08:43 +02:00
.gitreview Setup ha-guide infrastructure 2014-09-15 19:40:07 +02:00
README.rst Rename doc/ha-guide to doc/high-availability-guide 2014-09-21 07:03:26 +02:00
doc-test.conf Rename doc/ha-guide to doc/high-availability-guide 2014-09-21 07:03:26 +02:00
doc-tools-check-languages.conf Add RST infrastructure for HA Guide 2015-05-02 09:08:43 +02:00
test-requirements.txt Add RST infrastructure for HA Guide 2015-05-02 09:08:43 +02:00
tox.ini Use /draft for RST ha-guide 2015-05-06 19:25:54 +02:00

README.rst

OpenStack High Availability Guide

This repository contains the OpenStack High Availability Guide.

For more details, see the OpenStack Documentation wiki page.

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 root directory of the OpenStack High Availability Guide is doc/high-availability-guide.

To build the guide, move into the directory doc/high-availability-guide, then run the mvn command in that directory:

cd doc/high-availability-guide/
mvn clean generate-sources

The generated PDF documentation file is:

doc/high-availability-guide/target/docbkx/webhelp/high-availability-guide/high-availability-guide.pdf

The root of the generated HTML documentation is:

doc/high-availability-guide/target/docbkx/webhelp/high-availability-guide/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 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 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.