Go to file

Kenjiro Kosaka c559f21eeb [upstream-training] Use sphinx list-table for readability

In some of the page has a list such as the following, in the
"launchpad" slide. It is not easy to read.

- item: item description
- other_item: other_item description

Fix it using the list-table of the sphinx, to improve the readability.
Target is the following secsions.

- Bug status
- Bug importance
- Bug tags
- Bug

Change-Id: Ie71a6f227d67d7a6e5d3f90f8e0f934ad21bb15d
Closes-Bug: #1480812

2015-08-19 04:21:42 +00:00

doc

[upstream-training] Use sphinx list-table for readability

2015-08-19 04:21:42 +00:00

labs

Merge "Fix URLs in setup_neutron_controller.sh"

2015-08-05 14:35:42 +00:00

specs

Replace ci.o.o links with docs.o.o/infra

2015-05-14 21:38:20 +00:00

tools

Merge "Updates generatelabs scripts"

2015-04-19 12:13:36 +00:00

.gitignore

Adds upstream training to OpenStack gate

2015-04-07 14:27:06 +02:00

.gitreview

add .gitreview file

2014-06-11 18:04:08 -07:00

doc-test.conf

Add structure for inital import

2014-05-29 10:32:06 +08:00

doc-tools-check-languages.conf

Setup for translation

2014-08-18 21:05:12 +02:00

LICENSE

Add structure for inital import

2014-05-29 10:32:06 +08:00

README.rst

Show paths relative to this repo in README.rst

2014-09-27 11:13:51 +02:00

setup.cfg

Porting presentations to Sphinx/Hieroglyph

2015-03-26 14:33:38 +01:00

setup.py

Porting presentations to Sphinx/Hieroglyph

2015-03-26 14:33:38 +01:00

test-requirements.txt

Bump hieroglyph version to 0.7.1

2015-06-15 17:10:12 +02:00

tox.ini

Updates tox.ini to publish training guides draft

2015-07-22 11:00:14 +02:00

README.rst

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.

It includes these guides:

Associate Guide

Operator Guide

Developer 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 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.

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:

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.