openstack
/
operations-guide
Code Issues Proposed changes
OpenStack Operations Guide
226 Commits 2 Branches 0 Tags 27 MiB
Text 100%
Go to file
Andreas Jaeger 490a1bd561 Rename README to README.rst 
The file uses already the RST format in most cases. Let's rename
it so that it gets displayed nicely on github. Reformat a few
pieces to follow RST format.

Change-Id: I38b6bcdc282b23d09a3a2dc409e85caf60e1dafe
 		2014-02-02 12:22:35 +01:00
.tx Translation fixes for ops-guide 2014-01-16 16:39:42 +08:00
doc/openstack-ops Merge "Reformat glossary" 2014-02-01 19:17:10 +00:00
tools Remove tools/validate.py 2014-01-28 19:58:27 +01:00
.gitignore Enhance .gitignore 2014-01-01 21:43:38 +01:00
.gitreview Changes license to CC-by 3.0. 2013-06-12 13:27:23 -05:00
LICENSE Changes license to CC-by 3.0. 2013-06-12 13:27:23 -05:00
README.rst Rename README to README.rst 2014-02-02 12:22:35 +01:00
test-requirements.txt Updated from global requirements 2014-01-25 03:34:58 +00:00
tox.ini Allow passing arguments to tox 2014-01-03 10:43:48 +01:00

README.rst

OpenStack Operations Guide +++++++++++++++++++

This repository contains the source files for the OpenStack Operations Guide.

You can read this guide at docs.openstack.org/ops.

It was originally authored during a book sprint in February 2013. Read more about Book Sprints at http://www.booksprints.net.

Additionally, a tools directory contains tools for testing this guide.

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 15 and later:

yum install maven3

Contributing

This book is undergoing a custom edit with O'Reilly publishing and we welcome contributions to make it as accurate as possible. Our target is the Havana release.

The style guide to follow is at chimera.labs.oreilly.com <http://chimera.labs.oreilly.com/books/1230000000969/index.html.

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 meetup and offer contributions through our processes, the OpenStack wiki, blogs, or on IRC at #openstack on irc.freenode.net.

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.

Installing OpenStack

Refer to http://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.