Go to file

Pranav Salunke 191e317d84 Disables XML publishing

Address the change from XML to RST, XML based jobs are disabled. Current
content in Juno release for training guides is not going to include any
XML Docbook content. This patch disables the XML related jobs.

This patch will be followed by more jobs added to build RST content to
HTML and PDF format as required using the tools decided by the team. The
jobs disabled will be re-enabled with the appropriate set of tools.

Deletes all the jobs which are not required. Addresses changes done by
https://review.openstack.org/#/c/152118.

Change-Id: I91727929fe19dbc7487f2719cdba80157c543d6b

2015-02-23 08:10:25 +01:00

doc

Fix broken master repo

2015-02-22 21:53:56 +01:00

labs

Merge "Enable the Ubuntu cloud archive"

2015-02-19 20:30:11 +00:00

specs

Workflow documentation is now in infra-manual

2014-12-05 03:30:41 +00:00

tools

Updates training labs jobs

2015-02-07 11:39:16 +01:00

.gitignore

labs: don't track Vagrant ssh keys

2014-07-28 10:24:04 +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

test-requirements.txt

Add slides tox environment

2015-02-19 19:19:35 +01:00

tox.ini

Disables XML publishing

2015-02-23 08:10:25 +01: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.