History

Akihiro Motoki 383a5bec4b Reorganize directory structure

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

2016-10-09 03:35:30 +00:00

source

Reorganize directory structure

2016-10-09 03:35:30 +00:00

README.md

Updates README and deletes old files

2015-05-06 14:35:43 +02:00

README.md

Introduction

The subfolders contain the RST files related to the Training Guides.
Please refer the following link to get more information about this project https://launchpad.net/openstack-training-guides
Please follow the following wiki to get more information about development process of Training Guides. This should provide enough information to start contributing to training guides https://wiki.openstack.org/wiki/Training-guides
Training Guides is typically divided into four guides
1. Associate Training Guide
2. Operator Training Guide
3. Developer Training Guide
4. Architect Training Guide
Please follow the following wiki to get more information about development process of Training Guides. This should provide enough information to start contributing to training guides https://wiki.openstack.org/wiki/Training-guides

Structure of this folder

To get better idea of the design of this folder follow this blueprint https://blueprints.launchpad.net/openstack-training-guides/+spec/separate-folders-for-books
Typically book wise folders are created, read the following for more description:
1. associate-guide: This folder contains RST files related to Associate Training Guide.
2. common: This folder contains common files used by multiple training guides.
3. figures: This folder contains images used by all the training guides.
4. _static: This folder contains theming (CSS) for generating the HTML slides.