openstack/ha-guide
Code Issues Proposed changes
OpenStack High Availability Guide
739 Commits 1 Branch 0 Tags 6.2 MiB
Python 100%
d773e31e65
Go to file
Jenkins d773e31e65 Merge "Change controller IP addresses for HAProxy"
2016-03-05 00:13:45 +00:00
doc Merge "Change controller IP addresses for HAProxy" 2016-03-05 00:13:45 +00:00
tools Rename common-rst to common 2016-02-14 18:29:25 +09:00
.gitignore Remove unnecessary generated/ from gitignore 2016-01-27 15:55:49 +00:00
.gitreview Setup ha-guide infrastructure 2014-09-15 19:40:07 +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 Build Japanese HA Guide as draft 2016-02-15 15:15:54 +09:00
README.rst Update the documentation contributor guide link 2015-12-13 00:17:31 +05:30
test-requirements.txt Revert "Temporary require debtcollector" 2016-02-10 09:06:03 +00:00
tox.ini Rename common-rst to common 2016-02-14 18:29:25 +09:00

README.rst

OpenStack High Availability Guide

This repository contains the OpenStack High Availability Guide.

For more details, see the OpenStack Documentation wiki page.

Building

The root directory of the OpenStack High Availability Guide is doc/ha-guide.

To build the guide, run tox -e docs.

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

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.