training-guides

Add structure for inital import * Move the files into doc/training-guides subdirectory * Add README, LICENSE, tox test config

2014年05月29日 10:32:06 +08:00

[tox]

minversion = 1.6

Disables XML publishing 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

2015年02月06日 16:54:00 +01:00

envlist = slides

Add structure for inital import * Move the files into doc/training-guides subdirectory * Add README, LICENSE, tox test config

2014年05月29日 10:32:06 +08:00

skipsdist = True

[testenv]

Make sure that tox uses python2 by default Our documentation tools are not python3 compatible, so make sure that tox creates python2 virtual environments during tests. Change-Id: I86f160fb952ebce8abbac166fe43aae0e7d57005

2014年10月31日 08:35:20 +01:00

basepython = python2

Porting presentations to Sphinx/Hieroglyph 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

2015年02月06日 16:54:00 +01:00

setenv = VIRTUAL_ENV={envdir}

install_command = pip install -U {opts} {packages}

Add structure for inital import * Move the files into doc/training-guides subdirectory * Add README, LICENSE, tox test config

2014年05月29日 10:32:06 +08:00

deps = -r{toxinidir}/test-requirements.txt

whitelist_externals =

bash

cp

mkdir

rm

sed

[testenv:venv]

commands = {posargs}

Add slides tox environment Add slides tox environment for building RST based slides. This tox environment needs to be enhanced moving forward. For now it includes the doc8 test to test RST and txt files. Also setup doc8 testing. Change-Id: I76e0d235b9ee89c8de8033a7119e34cbcf1f0ddd

2015年02月19日 19:17:17 +01:00

[testenv:slides]

# New RST based environment for building slides

# Note: Resulting files will not be made available anywhere.

Disables XML publishing 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

2015年02月06日 16:54:00 +01:00

commands =

Add slides tox environment Add slides tox environment for building RST based slides. This tox environment needs to be enhanced moving forward. For now it includes the doc8 test to test RST and txt files. Also setup doc8 testing. Change-Id: I76e0d235b9ee89c8de8033a7119e34cbcf1f0ddd

2015年02月19日 19:17:17 +01:00

# Niceness test for doc directory

doc8 doc

Disables XML publishing 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

2015年02月06日 16:54:00 +01:00

# Build labs tar/zip files

Add slides tox environment Add slides tox environment for building RST based slides. This tox environment needs to be enhanced moving forward. For now it includes the doc8 test to test RST and txt files. Also setup doc8 testing. Change-Id: I76e0d235b9ee89c8de8033a7119e34cbcf1f0ddd

2015年02月19日 19:17:17 +01:00

mkdir -p publish-docs/trunk/training-guides

Disables XML publishing 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

2015年02月06日 16:54:00 +01:00

# Build training labs scripts

Add slides tox environment Add slides tox environment for building RST based slides. This tox environment needs to be enhanced moving forward. For now it includes the doc8 test to test RST and txt files. Also setup doc8 testing. Change-Id: I76e0d235b9ee89c8de8033a7119e34cbcf1f0ddd

2015年02月19日 19:17:17 +01:00

bash {toxinidir}/tools/generatelabs

Adds upstream training to OpenStack gate 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

2015年04月01日 10:38:06 +02:00

bash {toxinidir}/tools/generateslides

Add slides tox environment Add slides tox environment for building RST based slides. This tox environment needs to be enhanced moving forward. For now it includes the doc8 test to test RST and txt files. Also setup doc8 testing. Change-Id: I76e0d235b9ee89c8de8033a7119e34cbcf1f0ddd

2015年02月19日 19:17:17 +01:00

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

2015年04月19日 15:00:47 +02:00

[testenv:bashate]

deps = bashate

whitelist_externals = bash

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

2015年04月10日 23:22:05 +05:30

commands =

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

2015年04月19日 15:00:47 +02:00

bash -c "find {toxinidir} \

-not \( -type d -name .?\* -prune \) \ # prune all 'dot' dirs

-not \( -type d -name doc -prune \) \ # skip docs dir

-type f \ # only files

-not -name \*~ \ # skip editors, readme, etc

-not -name \*.md \

\( \

-name \*.sh -or \

-name \*rc -or \

-name functions\* -or \

-wholename \*/inc/\* -or \ # /inc files and

-wholename \*/lib/\* \ # /lib files are shell, but

\) \ # have no extension

-print0 | xargs -0 bashate -v"

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

2015年04月10日 23:22:05 +05:30

Add slides tox environment Add slides tox environment for building RST based slides. This tox environment needs to be enhanced moving forward. For now it includes the doc8 test to test RST and txt files. Also setup doc8 testing. Change-Id: I76e0d235b9ee89c8de8033a7119e34cbcf1f0ddd

2015年02月19日 19:17:17 +01:00

[doc8]

# Settings for doc8:

# File extensions to use

Porting presentations to Sphinx/Hieroglyph 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

2015年02月06日 16:54:00 +01:00

extension = .rst,.txt

Use Hieroglyph instead of landslide in Training Guides - 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

2015年04月20日 10:51:45 +02:00

ignore-path = doc/upstream-training/build/*,doc/training-guides/*/build/*

Disables XML publishing 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

2015年02月06日 16:54:00 +01:00

Publish upstream-training slides as draft 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

2015年05月13日 20:16:12 +02:00

[testenv:checkbuild]

commands =

# Niceness test

doc8 doc/upstream-training

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

2015年07月01日 13:53:22 +02:00

doc8 doc/training-guides

Publish upstream-training slides as draft 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

2015年05月13日 20:16:12 +02:00

# Build upstream-training slides

sphinx-build -b slides doc/upstream-training/source/ doc/upstream-training/build/slides

[Upstream training] new landing page 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

2015年09月11日 14:25:50 +02:00

# Build upstream landing page index.html

sphinx-build -b html doc/upstream-training doc/upstream-training/build/slides doc/upstream-training/index.rst

# Build training-guides slides

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

2015年07月01日 13:53:22 +02:00

sphinx-build -b slides doc/training-guides/associate-guide/ doc/training-guides/associate-guide/build/slides

[Upstream training] new landing page 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

2015年09月11日 14:25:50 +02:00

# Publish as draft

Publish upstream-training slides as draft 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

2015年05月13日 20:16:12 +02:00

mkdir -p publish-docs/draft/upstream-training

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

2015年07月01日 13:53:22 +02:00

mkdir -p publish-docs/draft/training-guides

Publish upstream-training slides as draft 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

2015年05月13日 20:16:12 +02:00

rsync -av doc/upstream-training/build/slides/ publish-docs/draft/upstream-training/

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

2015年07月01日 13:53:22 +02:00

rsync -av doc/training-guides/associate-guide/build/slides/ publish-docs/draft/training-guides/

Publish upstream-training slides as draft 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

2015年05月13日 20:16:12 +02:00

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

2015年05月16日 19:38:27 +02:00

[testenv:publishdocs]

Publish upstream-training slides as draft 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

2015年05月13日 20:16:12 +02:00

commands =

# Build upstream-training slides

sphinx-build -b slides doc/upstream-training/source/ doc/upstream-training/build/slides

[Upstream training] publish Upstream's new index.html as draft Publish new index.html for Upstream training on http://docs.openstack.org/draft/upstream-training. Change-Id: I5d6295e6fb4e69fe63163ef46f75e5618746aa89

2015年09月17日 15:31:48 +02:00

# Build upstream landing page index.html

sphinx-build -b html doc/upstream-training doc/upstream-training/build/slides doc/upstream-training/index.rst

# Build training-guides slides

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

2015年09月07日 13:57:56 +02:00

sphinx-build -b slides doc/training-guides/associate-guide/ doc/training-guides/associate-guide/build/slides

[Upstream training] publish Upstream's new index.html as draft Publish new index.html for Upstream training on http://docs.openstack.org/draft/upstream-training. Change-Id: I5d6295e6fb4e69fe63163ef46f75e5618746aa89

2015年09月17日 15:31:48 +02:00

# Publish as draft

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

2015年09月07日 13:57:56 +02:00

mkdir -p publish-docs/draft/training-guides

rsync -av doc/training-guides/associate-guide/build/slides/ publish-docs/draft/training-guides/

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

2015年09月28日 15:22:49 +02:00

# Publish

mkdir -p publish-docs/upstream-training

rsync -av doc/upstream-training/build/slides/ publish-docs/upstream-training/

Publish upstream-training slides as draft 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

2015年05月13日 20:16:12 +02:00

Update tox.ini - 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

2015年03月31日 10:40:04 +02:00

[testenv:upstream-slides]

commands =

# Niceness test

doc8 doc/upstream-training

# Build upstream-training slides

sphinx-build -b slides doc/upstream-training/source/ doc/upstream-training/build/slides

[Upstream training] publish Upstream's new index.html as draft Publish new index.html for Upstream training on http://docs.openstack.org/draft/upstream-training. Change-Id: I5d6295e6fb4e69fe63163ef46f75e5618746aa89

2015年09月17日 15:31:48 +02:00

# Build upstream landing page index.html

sphinx-build -b html doc/upstream-training doc/upstream-training/build/slides doc/upstream-training/index.rst

Use Hieroglyph instead of landslide in Training Guides - 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

2015年04月20日 10:51:45 +02:00

[testenv:training-slides]

commands =

# Niceness test

doc8 doc/training-guides

[Upstream training] publish Upstream's new index.html as draft Publish new index.html for Upstream training on http://docs.openstack.org/draft/upstream-training. Change-Id: I5d6295e6fb4e69fe63163ef46f75e5618746aa89

2015年09月17日 15:31:48 +02:00

# Build slides

Use Hieroglyph instead of landslide in Training Guides - 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

2015年04月20日 10:51:45 +02:00

sphinx-build -b slides doc/training-guides/associate-guide/ doc/training-guides/associate-guide/build/slides

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

105 lines

3.8 KiB

INI

Raw Normal View History

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

105 lines 3.8 KiB INI Raw Normal View History Unescape Escape

105 lines

3.8 KiB

INI

Raw Normal View History