6c67b2be17
The syntax of the divers description was confusing and 'maybe' was incorrectly used. Change-Id: Id3324c3c142f9ff9060f011b578ad060621f5edb |
||
|---|---|---|
| doc | ||
| tools | ||
| www | ||
| .gitignore | ||
| .gitreview | ||
| doc-test.conf | ||
| doc-tools-check-languages.conf | ||
| LICENSE | ||
| projects.txt | ||
| 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:
- Admin User Guide
- Architecture Design Guide
- Cloud Administrator Guide
- Command-Line Interface Reference
- Configuration Reference
- End User Guide
- Heat Orchestration Template reference
- HOT Guide
- Installation Guides
- Virtual Machine Image Guide
In addition to the guides, this repository contains:
- docs.openstack.org:
www
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 20 and later:
yum install mavenOn openSUSE 13.1 and later:
zypper ar http://download.opensuse.org/repositories/devel:/tools:/building/openSUSE_13.1/devel:tools:building.repo
zypper install mavenBuilding
The different manuals are in subdirectories of the
openstack-manuals/doc/ directory.
DocBook guides
For example, the root directory of the OpenStack Virtual Machine
Image Guide is openstack-manuals/doc/image-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/image-guide/
mvn clean generate-sourcesThe generated PDF documentation file is:
openstack-manuals/doc/image-guide/target/docbkx/webhelp/image-guide/image-guide.pdfThe root of the generated HTML documentation is:
openstack-manuals/doc/image-guide/target/docbkx/webhelp/image-guide/content/index.htmlRST guides
Then, you can see that the openstack-manuals/doc/user-guides is the RST based guide, So we can't use mvn command. You can use tox to prepare virtual environment and build it:
tox -e docsThe root of the generated End User Guide HTML documentation is:
openstack-manuals/doc/user-guides/build/html/index.htmlThe root of the generated Admin User Guide HTML documentation is:
openstack-manuals/doc/user-guides/build-admin/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 checklinks- to run the tests for working remote URLstox -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 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 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.