openstack
/
training-guides
Code Issues Proposed changes
Community created, open source training guides for OpenStack.
2,195 Commits 1 Branch 0 Tags 48 MiB
Shell 84%
Python 16%
Go to file
Akihiro Motoki 31b6059f55 generatepot-rst.sh: Drop UUID filtering 
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
 		2023-09-18 17:10:47 +09:00
doc Imported Translations from Zanata 2022-10-17 04:09:00 +00: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
LICENSE Add structure for inital import 2014-05-29 10:32:06 +08:00
README.rst Update IRC references 2021-05-27 09:04:43 -07:00
bindep.txt Add bindep.txt for publishing translated pages 2019-10-07 22:43:23 +09:00
setup.cfg Small cleanups 2020-04-07 13:13:45 +02:00
setup.py Porting presentations to Sphinx/Hieroglyph 2015-03-26 14:33:38 +01:00
test-requirements.txt Update to hieroglyph 2.0 2020-06-27 20:22:30 +02:00
tox.ini generatepot-rst.sh: Drop UUID filtering 2023-09-18 17:10:47 +09: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 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:

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

Published guides

Guides are published at:

Release Notes

Repository