Go to file

Ian Y. Choi 8fd92f5c6c [upstream] Revise closing exercise section

- To make a generalized exercise, this commit changes from
  Spain travel plan to a plan for a country where group members
  would like to visit.
- IRC meeting info is added to encourage students to have
  meeting for discussion.
- Let's try students to improve the patchset they first submitted
  as a draft.
- More steps would be to expand with trip details as a blueprint.

Change-Id: I3415b5dd13fcca2d615384fd189c64c5416fbba8

2016-10-24 19:30:03 +09:00

doc

[upstream] Revise closing exercise section

2016-10-24 19:30:03 +09:00

labs

labs: Remove labs section

2015-11-27 15:36:47 +01:00

specs

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

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

tools

Fix generate pot script

2016-10-14 14:52:30 +09:00

.gitignore

Cleanup .gitignore rule for labs

2016-10-19 18:29:57 +09:00

.gitreview

add .gitreview file

2014-06-11 18:04:08 -07: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

Update the version of openstackdocstheme

2016-09-28 02:44:42 +00:00

tox.ini

Reorganize directory structure

2016-10-09 03:35:30 +00: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.