257cbcfa7a
This patch as well fixes the path to the generated PDF documentation which was wrong because it misses the last 'training-guides' directory. Change-Id: I243002eca1b68bbce1c7d4b2985a28a31da968e1
98 lines
2.7 KiB
ReStructuredText
98 lines
2.7 KiB
ReStructuredText
OpenStack Training Guides
|
|
+++++++++++++++++++++++++
|
|
|
|
This repository contains open source training manuals that can be
|
|
used to learn about the OpenStack project.
|
|
|
|
For more details, see the `OpenStack Training Guides wiki page
|
|
<https://wiki.openstack.org/wiki/Training-guides>`_.
|
|
|
|
It includes these guides:
|
|
|
|
* Associate Guide
|
|
* Operator Guide
|
|
* Developer Guide
|
|
|
|
|
|
Prerequisites
|
|
=============
|
|
`Apache Maven <http://maven.apache.org/>`_ 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
|
|
|
|
Building
|
|
========
|
|
The different guides are in subdirectories of the
|
|
``doc/`` directory.
|
|
|
|
To build the guides, look for a ``pom.xml`` file within a subdirectory,
|
|
then run the ``mvn`` command in that directory. For example::
|
|
|
|
cd doc/training-guides/
|
|
mvn clean generate-sources
|
|
|
|
The generated PDF documentation file is::
|
|
|
|
doc/training-guides/target/docbkx/webhelp/training-guides/training-guides.pdf
|
|
|
|
The root of the generated HTML documentation is::
|
|
|
|
doc/training-guides/target/docbkx/webhelp/training-guides/content/index.html
|
|
|
|
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 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
|
|
<http://www.openstack.org/join>`_.
|
|
|
|
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 <http://wiki.openstack.org>`_, 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 <https://wiki.openstack.org/wiki/Documentation/HowTo>`_.
|
|
|
|
|
|
Bugs
|
|
====
|
|
|
|
Bugs should be filed on Launchpad, not GitHub:
|
|
|
|
https://bugs.launchpad.net/openstack-training-guides
|
|
|
|
|
|
Installing
|
|
==========
|
|
Refer to http://docs.openstack.org to see where these documents are published
|
|
and to learn more about the OpenStack project.
|