openstack/training-guides - training-guides - OpenDev: Free Software Needs Free Tools

With switch of propose-translation-update nodeset to noble,
tox version was bumped and whitelist_externals is no longer
respected there, which leads to job failure.
Change-Id: I075b4f219501ba63d3cd2fb52f6c40e0a18fd153
Signed-off-by: Dmitriy Rabotyagov <dmitriy.rabotyagov@cleura.com>

The tags framework has been discontinued for a long time.
https://governance.openstack.org/tc/reference/tags/
https://governance.openstack.org/tc/resolutions/20211224-tags-framework-removal.html
Change-Id: Ib7fba258ef19f594fb68ba97e3fa242f1d0fe1ef
Signed-off-by: Ivan Anfimov <lazekteam@gmail.com>

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

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

Remove install_command from tox.ini, the default is good enough
Remove obsolete sections from setup.cfg, update git URL.
Change-Id: I0fb397e32499b90a2ecd8e5fb0489a58e6017827

Follow job rename in openstack-manuals, remove now unused
checkbuild environment.
Depends-On: https://review.opendev.org/676956
Change-Id: Icf5ab7c00a17cda9c6f54dbdf6f53d165d87da3c

This allows simplifying the CI jobs.
Depends-On: https://review.opendev.org/676489
Change-Id: I955f360bcff9affe209b3bf201258828911c251d

periodic job failed since some weeks due the usage of Sphinx 2.0
in Python 2.7, called by the shell script outside venv
see:
http://logs.openstack.org/periodic/opendev.org/openstack/training-guides/master/propose-translation-update/a09c131/
Maybe get job working again after some weeks.
Requires still a general patch for propose-translation-update to run
on Bionic with Sphinx 2 and Python 3.
Change-Id: I40a271bdc171ee7dc433178633c190c7bd1e8e5f

As latest Sphinx is requiring python 3 this patch sets basepython to
python 3 in the [testenv] section of tox.ini to make sure that is what
the environment is using so we don't need to pin the Sphinx version.
Change-Id: I217ee30359719ab3793b1329ec5e3f1a03848b8f

The commands used by constraints need at least tox 2.0. Update to
reflect reality, which should help with local running of constraints
targets.
Change-Id: I39ecb4fb4a08f37b92902908f55b6023bc883d97

We want to default to running all tox environments under python 3, so
set the basepython value in each environment.
We do not want to specify a minor version number, because we do not
want to have to update the file every time we upgrade python.
We do not want to set the override once in testenv, because that
breaks the more specific versions used in default environments like
py35 and py36.
Change-Id: I8f1883011c0831b78a5f099e1ddcf98a77e4005a

The last content change to doc/training-guides was September 2016. We
still publish the content to /draft which is obsolete. Stop this
publishing for now.
Once training-guides gets updates, we can discuss publishing to a new
location.
Change-Id: I5086007cd76859e538929b1bda05babab9bc7ec6

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

Use toctree in slide-index.rst to ensure all documents are listed
in toctree to avoid sphinx warnings.
Exclude associate-guides from HTML build. Also remove 'source' from
doc/training-guides/conf.py as it does not exists in doc/training-guide.
Ensure associate-guide/notes files are in toctree to avoid sphinx warnings.
These files are referred to by including them, so hidden toctrees are used.
Also specifies sphinx-build -W option to detect warnings.
Change-Id: I298202e3304d02f362cc4bf9cc58686857040fd8

Most warnings are "document isn't included in any toctree".
This is because documents are not listed in any toctree.
In the upstream training document, explicit toctree looks unnecessary,
so this commit adds a hidden toctree to cover all unlisted documents.
It makes these documents reachable from standard navigation (prev/next).
doc/upstream-training/README.rst is not intended to link from the document.
Add README.rst to exclude_patterns in conf.py.
Also specifies sphinx-build -W option to detect warnings.
Change-Id: I42750cde20a35342dce7857e275f7fa27211236b

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

Most warnings can be addressed by using toctree directive
and there is no reason to use toctree directive.
In addition, sections in slide-index.rst has been reorganized
to match the sections in index.rst.
The sections in index.rst looks better.
Also specify -W option to sphinx-build so that the gate job
can detect warnings.
Change-Id: I70ca7c2b61cbbb48fd0ea5e6cc0d68aaa09b6d87

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

Doctrees are build artefacts thta do not need to be published, place
them in separete directories so that they won't get published.
Change-Id: I8839f08d2e85ccb751d354be5f48bdfd95b886e2

This also enables publishing of git.rst.
Change-Id: Id4c25517de846031d8a9201be144e7031db4bdb7

This adds documentation for using IRC with Linux and Mac OS.
Change-Id: Ic41e7040d6980fceb07e9bdba84ab74dae40ff90

Also, clean up langing page
Change-Id: I912e7ae5a8fe11a6d21d59213cc159e010f91ede

Change-Id: I71d08c64547305b7bb630e8973bd141419cab5e0

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

training-guides did not have any landing page,
made difficult users to start reading the guide.
This commit adds a landing page for training-guides.
The previous landing page with slide format is moved from
index.rst to slide-index.rst.
Closes-Bug: #1535393
Change-Id: I8b43349679239e511173180777b27c3b18b518fb

Change-Id: Ic0ee2cd1f588a909f8739ea3495250e99b7706ab

* since training-guides repo is not so frequently updated,
 publish the translated guides with the original guide.
* also, remove the unnecessary tox environment.
Change-Id: I8b413d7e8343e661e3d1bdeb5db8b58fa07c0e29

* attach a sample Japanese language file to test multiple language building.
Change-Id: I48b2d87b752c01cf71d43b3766bd238d37a8c350

To avoid unnecessary warning.
Change-Id: I9bf6b7a03b0b9bea826dc906fe2ab7e0094e3ac9

Change-Id: I0d73acfda324f4d3af2470aed8d7b3bf64f19c75

Move content from https://wiki.openstack.org/wiki/OpenStack_Upstream_Training/Info
to the RST format.
Change-Id: Ic4d6b638015a240341fc1664283650ac35fb8fc6

Upstream training is currently published as draft. Enable publishing as a
regular content on docs.openstack.org/upstream-training.
Change-Id: I9efa7918d84acd7d637f063b3ef8b07291072c15

Publish new index.html for Upstream training on
http://docs.openstack.org/draft/upstream-training.
Change-Id: I5d6295e6fb4e69fe63163ef46f75e5618746aa89

Adds a new openstackdocs themed landing page for Upstream training. Renames
old landing page to slide-index.html (so users that prefer slide-only landing
page can still use it).
Change-Id: I8575af8e5b70940e5252c86e8c584261e0e29ab4
Closes-Bug: #1494724 

Update publishdocs target so that the training-guides
slides will be published at
http://docs.openstack.org/draft/training-guides
Change-Id: I7418dbbc5935b86d49fd5917041d7e4e2af2d3cf

Start publishing training gudies to draft. This also
enables preview during the review on the gerrit interface.
Change-Id: Ibd7090f6ce130fbec73586acece223f81b120122

The tox environment name should be publishdocs for proper publishing.
Change-Id: I654c20a2adcf83626971b445b0909cbffb40d944

Create publishbuild and checkbuild targets so that the upstream-training
slides will be gated and published at
http://docs.openstack.org/draft/upstream-training
Change-Id: I2ad3736cbd5e66d07bb84ffb9f805a0270663f7b

- delete landslide files
- convert existing rst files to Hieroglyph format
- add new slide build command to the tox.ini
- change default CSS to make output more OpenStack-like
 - used the Foundation Slides' OpenStack-Powered-April2015.ppt
 - title slide with image
 - white h1 css text
 - "openstack's special red" for h2
Change-Id: Icb22482862a85c3d174d9292fb470f64fb95f7aa

Updates bashate checks to cover the labs folder more throughly and
also omit all other possible files.
Change-Id: I9ad1ef55b54351e21175db8bb08bc44526e952e9

bashates all scripts under labs folder.
Change-Id: I99b3fbf7ee3eee41a1917cba236f78dc68f155e3
Closes-Bug: #1430649 

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

- rename tox option for building upstream slides only (useful when "debugging"
slide content and appearance), adds doc8 syntax checking
- update ignore-path for doc8 (include also the (future) build directory for
the training guides)
Change-Id: I112f4f20f676e369f7369ed036b14464862ea3ef

modifided tox.ini and requirements.txt to install
hieroglyph, added some changes in the styles
of the individual .rst files to support hiero
Change-Id: Id2674e593857470cf4efa0706a4fbda33813f374

Address the change from XML to RST, XML based jobs are disabled. Current
content in Juno release for training guides is not going to include any
XML Docbook content. This patch disables the XML related jobs.
This patch will be followed by more jobs added to build RST content to
HTML and PDF format as required using the tools decided by the team. The
jobs disabled will be re-enabled with the appropriate set of tools.
Deletes all the jobs which are not required. Addresses changes done by
https://review.openstack.org/#/c/152118.
Change-Id: I91727929fe19dbc7487f2719cdba80157c543d6b