Currently for both upstream-training and training-guide directory
slides are stored in the subdirectories of landing web pages.
It is not easy to capture the directory structure and this requires
Sphinx conf file to have unnecessary excluded entries.
This commits reorganizes each directory to the following structure.
It follows the convention in the documentation project.
doc/upstream-training:
(previous)
+-- README.rst
+-- website RST files
+-- conf.py (for website)
+-- build/
+-- source/
+-- slide RST files
+-- conf.py (for slides)
+-- _assets/
+-- _static/
+-- locale/
(new)
+-- README.rst
+-- build/
+-- source/
+-- website/
| +-- website RST files
| +-- conf.py (for website)
| +-- _assets/
+-- slides/
| +-- slide RST files
| +-- conf.py (for slides)
| +-- _assets/
| +-- _static/
+-- locales/
training-guide directory is reorganized similarly.
training-guide _assets/README has been removed as it is used.
Also updates tox.ini to share target command definitions.
We do not need to have same things in many places.
Note that this commit does not change the build document paths.
Change-Id: I5a21f170c06d8f71f1f2d0df354e6d6280cb29d0
Add marker correctly, we cannot redirect in tox.ini, thus need a shell
script to do the redirects.
This adds a new shell script to just add a marker call add-marker.sh
Change-Id: I76cd140ad5ac1fb2163a11ab760134256b04f8dd
For new infra publishing setup, each guide needs have a .root-marker
file in its top-level directory. Add the marker for each guide.
Change-Id: I46026a90d148b28c4e4b80177c912b0954413aef
It also enables to publish translations on git.rst.
Modification is like https://review.openstack.org/#/c/300067 .
Change-Id: I5d8828270f84bfd222d3bc930d92d0928a6d89b8
generatelabs file was used to created for training-labs
scripts, and is not used in this repository anymore.
Also, updated tox.ini to delete generatelabs references
Change-Id: I86894506c62e2466734194f62a28811e5c2c8c4e
Updates to ignore unwanted files. If someone exports their labs
scripts while having existing clusters deployed, these changes will
allow auto-ignore unwanted files while creating the compressed files.
Change-Id: I6ecae37b1d97a7c0c12854f5f3240b842da84af7
Removes unnecessary "bash -c" from the scripts as they are not
required and already being called from the tox.ini.
Change-Id: I533e32d37fd48c9f137ff528f85fb06437f322ce
Update the current gate 'slides' to build and publish upstream
training content. This patch does the following changes.
* Adds generateslides script to use sphinx/hieroglyph to build slides
* Updates tox.ini to use generateslides script
* Update .gitignore to ignore _build/ directory which is the default
folder for generated output generated by sphix.
Hence forth, any changes to the upstream training rst slides will be
gated and published, also it is essential to note that these jobs are
new and may not be accurate or reliable to address all the errors in
the rst slides.
Change-Id: I8a220dd31501f9b3733a6282d7048fe283d2a0d1
After https://review.openstack.org/#/c/144685 merges,
the automatically generated configuration reference
tables will be marked up as
<option>option_name</option> = <replaceable>default_value</replaceable>
As none of this should be translated (option_name is the same
regardless of language), this patch updates generatepot to ignore
option_name s tagged with <option> for translation.
This should significantly reduce the number of strings required for
translation from the common directory in particular, where
many of the 8000-odd strings do not actually need translation.
Change-Id: Iedd14c6666b6072b79545082afd8e39d1011ffbf
We have git to track the authorship of files. It is not necessary to use
the @author tags in the copyright statements.
Change-Id: Idf862b8d5e92a7e0f9697d4d1a95a4c225d18dde
Setup the same way the other repos are setup.
Note that currently no jobs are run since training-guides has no
localization. But let's keep the setup in sync.
Change-Id: I7e9ced06c3ad9997d7f790a5a4d507fa13ef0490
Note that this does not build any translated guides yet since we do not
have the guides translated properly into any language.
This infrastructure is needed to enable the translations.
Change-Id: I2accb7e713ed88a3e06edca31bb7691d2d0bc14c
