openstack
/
operations-guide
Code Issues Proposed changes
OpenStack Operations Guide
1,159 Commits 2 Branches 0 Tags 27 MiB
Text 100%
Go to file
Andreas Jaeger 1dbb3502fb Note that repository is read-only 
With the import of the RST draft version into openstack-manuals,
note that the repository is now read-only.

Change-Id: I9b2e842b06aff1dae6313ff54c42cbdfdbc0166f
Depends-On: Id25e02aa0b2219fd9141d1354124386cb59bb856
 		2016-04-29 17:40:39 -05:00
doc Correct the wrong web form name 2016-04-28 14:27:02 +00:00
tools [ops-guide] Fix wrong path to common files 2016-03-10 15:43:32 +09:00
.gitignore [ops-guide] Set up initial RST structure 2016-03-10 03:28:44 +00: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 Note that repository is read-only 2016-04-29 17:40:39 -05:00
doc-test.conf Remove extra line from doc-test.conf 2014-02-12 21:39:49 +01:00
doc-tools-check-languages.conf [ops-guide] Fix wrong path to common files 2016-03-10 15:43:32 +09:00
other-requirements.txt Install only required packages 2016-03-28 19:18:08 +02:00
test-requirements.txt [ops-guide] Set up initial RST structure 2016-03-10 03:28:44 +00:00
tox.ini [ops-guide] Set up initial RST structure 2016-03-10 03:28:44 +00:00

README.rst

OpenStack Operations Guide

This content is read-only now, any changes to operations guide will be done in the openstack-manuals repository where the guide lives in doc/ops-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 20 and later:

yum install maven

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.

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 -e buildlang -- $LANG - to build the manual for language $LANG

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.