97dc392088
This commit was bulk generated and pushed by the OpenDev sysadmins as a part of the Git hosting and code review systems migration detailed in these mailing list posts: http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html Attempts have been made to correct repository namespaces and hostnames based on simple pattern matching, but it's possible some were updated incorrectly or missed entirely. Please reach out to us via the contact information listed at https://opendev.org/ with any questions you may have.
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 mavenOn Fedora 15 and later:
yum install maven3Contributing
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 teststox -e checksyntax- to run syntax checkstox -e checkdeletions- to check that no deleted files are referencedtox -e checkbuild- to actually build the manualtox -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.