openstack/training-guides
Code Issues Proposed changes
Community created, open source training guides for OpenStack.
2,142 Commits 1 Branch 0 Tags 48 MiB
Shell 84%
Python 16%
401cbfe85e
Go to file
Ian Y. Choi 401cbfe85e Add bindep.txt for publishing translated pages 
This addition intends to solve the following error messages
executing build-tox-manuals-publishdocs job:
 - msgmerge: command not found
 - msgfmt: command not found

Change-Id: I703d9d526339fa2ac5302a156cd290000aa337a7
2019-10-07 22:43:23 +09:00
doc Imported Translations from Zanata 2019-10-04 08:41:54 +00:00
labs Update for OpenDev changes 2019-04-22 17:50:05 +02:00
specs Update for OpenDev changes 2019-04-22 17:50:05 +02:00
tools Publish to publish-docs/html 2019-08-15 06:44:32 +02:00
.gitignore Revert "Add '.pyc' in gitignore" 2018-08-17 16:35:22 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:39:39 +00:00
.zuul.yaml Rename docs job 2019-08-16 16:25:38 +02:00
bindep.txt Add bindep.txt for publishing translated pages 2019-10-07 22:43:23 +09:00
LICENSE Add structure for inital import 2014-05-29 10:32:06 +08:00
README.rst Rename docs job 2019-08-16 16:25:38 +02:00
setup.cfg Update home-page 2019-01-23 02:06:58 +00:00
setup.py Porting presentations to Sphinx/Hieroglyph 2015-03-26 14:33:38 +01:00
test-requirements.txt Update openstackdocstheme options 2019-04-23 16:36:01 +02:00
tox.ini Rename docs job 2019-08-16 16:25:38 +02:00

README.rst

Team and repository tags

image

OpenStack Training Guides

This repository contains open source training material that can be used to learn about using and different ways of contributing to OpenStack (Upstream training).

For more details, see the OpenStack Training Guides wiki page.

It includes:

  • Upstream training
  • Training guides (draft)

Both guides include a set of slides used in the training events.

Building

Various manuals are in subdirectories of the doc/ directory.

Guides

All guides are in the RST format. You can use tox to prepare virtual environment and build all guides:

$ tox

You can find the root of the generated HTML documentation at:

doc/upstream-training/build/slides/index.html
doc/training-guides/build/slides/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 publishdocs - to actually build all guides (used in CI for building and publishing)
  • tox -e upstream-slides - build the Upstream training
  • tox -e training-slides - build the Training guides

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 OpenStack Documentation Contributor Guide.

Bugs

Bugs should be filed on Launchpad, not GitHub:

https://bugs.launchpad.net/openstack-training-guides

Published guides

Guides are published at:

Release Notes

Repository