e9f6757e1b
The install guide consistently uses *_PASS for its password replacement labels. ADMIN_PASSWORD was introduced when updating keystone for bootstrap. This broke consistency with both the Environment --> Security section, and also the Create a domain, projects, users, and roles section that follows keystone set-up. In order to avoid an onslaught of bug reports from the copy/paste crowd, this patch changes ADMIN_PASSWORD to ADMIN_PASS in the keystone setup section, keeping the other sections at the original ADMIN_PASS. Change-Id: Idf8a9033f229ce325f5e4eb9da6d1241b9923cd3
OpenStack Manuals
This repository contains documentation for the OpenStack project.
For more details, see the OpenStack Documentation Contributor Guide.
It includes these manuals:
- Administrator Guide
- Architecture Design Guide
- Command-Line Interface Reference
- Configuration Reference
- Documentation Contributor Guide
- End User Guide
- High Availability Guide
- Installation Guide
- Networking Guide
- Operations Guide
- Virtual Machine Image Guide
In addition to the guides, this repository contains:
- docs.openstack.org contents:
www
Building
Various manuals are in subdirectories of the doc/
directory.
Guides
All guides are in the RST format. You can use tox to prepare virtual environment and build all guides:
tox -e docsYou can also build a specific guide.
For example, to build OpenStack End User Guide, use the following command:
tox -e build -- user-guideYou can find the root of the generated HTML documentation at:
doc/user-guide/build/html/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 linkcheck- to run the tests for working remote URLstox -e checkniceness- to run the niceness teststox -e checkbuild- to actually build the manualtox -e checklang- to build translated manuals
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 OpenStack Documentation Contributor Guide.
Generated files
Some documentation files are generated using tools. These files
include a do not edit header and should not be modified by
hand. Please see Generated
files.
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.