31b6059f55
tools/generatepot-rst.sh has an awk filter to drop UUID from POT files,
but it is unnecessary now. It was introduced to strip UUID information
which was added by default in Sphinx <1.3 [1] in openstack-manuals.
Sphinx >=1.3 does not output UUID information by default [2],
so is is no longer needed.
In addition, (g)awk 5.0 or later (adopted in Ubuntu 20.04 or later)
complains the current awk regexp. I think it is the time to drop it
rather than fixing the regexp.
[1] 993647f316
[2] https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-gettext_uuid
Related-Bug: #2035226
Change-Id: I9ed81d5edefe904fcf7e6f9aed2a00d756299d04
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 Open Infrastructure 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.oftc.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: