e43daab321
hieroglyph 2.0 works with python 3 and Sphinx 2, update to it. Update some other requirements as well. Cleanup tox.ini a bit. Switch to openstackdocstheme 2.2.1 version. Using this versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. Disable openstackdocs_auto_version to not auto-version the documents. Disable openstackdocs_auto_name to use 'project' variable as name. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: Ib8ba3e3f514688d06a07598e7d6ceffa79f26220
Team and repository tags
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:
$ toxYou can find the root of the generated HTML documentation at:
doc/upstream-training/build/slides/index.html
doc/training-guides/build/slides/index.htmlTesting 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 trainingtox -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:
Published guides
Guides are published at: