a14a288d18
By request, I am posting a cosmetic changeset to clean up spelling, formatting, whitespace, and comments (some visible by script users) in training-labs. A few variables and function names have been changed (decapitalization, consistency). Scope: This changeset does not affect the workings of the code and therefore does not fix bugs. Bug fixes go into separate patches. Special notes: * Scripts/Neutron/Neutron.sh still installs quantum, but the naming within said script is now consistent. That can only be temporary, a switch to a more recent release should happen soonish. * I left the numbers for steps in some scripts (Glance.sh); maybe the manuals are meant to refer to these numbers!? Of course, they will change occasionally (this time, for instance, I changed them to match the actual order). * Scripts that use non-standard functionality should use bash, not sh; shebangs fixed * I didn't touch README.md, training-guides-cluster-scripts.tar: these, too, are for a separate changeset Related-Bug: #1312764 Change-Id: I01005f96b03ef3fbeeaa0b9d9d0e804aaed7af83 |
||
|---|---|---|
| .tx | ||
| doc | ||
| tools | ||
| www | ||
| .gitignore | ||
| .gitreview | ||
| doc-test.conf | ||
| LICENSE | ||
| README.rst | ||
| test-requirements.txt | ||
| tox.ini | ||
OpenStack Manuals
This repository contains documentation for the OpenStack project.
For more details, see the OpenStack Documentation wiki page.
It includes these manuals:
- Installation Guides
- Cloud Administrator Guide
- High Availability Guide
- Security Guide
- Virtual Machine Image Guide
- End User Guide
- Admin User Guide
- Training Guides
In addition to the guides, this repository contains:
- docs.openstack.org:
www- tools for gating tests prior to merging documentation in this repo
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 maven3Building
The different manuals are in subdirectories of the
openstack-manuals/doc/ directory.
For example, the root directory of the OpenStack User Guide
is openstack-manuals/doc/user-guide.
To build a specific guide, look for a pom.xml file
within a subdirectory, then run the mvn command in that
directory. For example:
cd openstack-manuals/doc/user-guide/
mvn clean generate-sourcesThe generated PDF documentation file is:
openstack-manuals/doc/user-guide/target/docbkx/webhelp/user-guide.pdfThe root of the generated HTML documentation is:
openstack-manuals/doc/user-guide/target/docbkx/webhelp/user-guide/content/index.htmlTesting 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 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 Documentation HowTo.
Bugs
Bugs should be filed on Launchpad, not GitHub:
Installing
Refer to http://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.