openstack
/
operations-guide
Code Issues Proposed changes
OpenStack Operations Guide
118 Commits 2 Branches 0 Tags 27 MiB
Text 100%
Go to file
Andreas Jaeger 69a434ad38 Allow passing arguments to tox 
Pass extra arguments to tests.

This allows to run for example:
       tox -- --force

Also reorder elements of envlist.

Change-Id: I8595db1fb9ce685c85f76b94714b270ea34c9d7d
 		2014-01-03 10:43:48 +01:00
.tx Adds Transifex client settings. 2013-07-23 22:42:33 +09:00
doc/openstack-ops Merge "Improvement of CPU allocation explanation" 2014-01-02 16:36:50 +00:00
tools Add Docbook XML mode in tools/generatedocbook 2013-07-09 13:45:06 +09: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 Enable for gating with openstack-doc-tools 2014-01-02 16:58:22 +01:00
test-requirements.txt Enable for gating with openstack-doc-tools 2014-01-02 16:58:22 +01:00
tox.ini Allow passing arguments to tox 2014-01-03 10:43:48 +01:00

README 

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

You can read this guide at `docs.openstack.org/ops <http://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 <http://maven.apache.org/>`_ 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 <http://www.openstack.org/join>`_.
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 <http://wiki.openstack.org>`_, 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.