Adds book wise folders and readme file.
Initial commit for restructuring the XML files under training-guides. Adds book wise folders, readme file, basic-install-guide folder, common folder to address the given blueprint. Change-Id: I8c8e90b74d026864dbf50ba2062581b1490f3d15 Implements: blueprint separate-folders-for-books
This commit is contained in:
Pranav Salunke
parent
1a172fc252
commit
642c8ea8d4
42
doc/training-guides/README.md
Normal file
42
doc/training-guides/README.md
Normal file
@ -0,0 +1,42 @@
|
||||
Introduction
|
||||
============
|
||||
|
||||
* This folder contains all the XML files which provide the text in HTML/PDF
|
||||
format.
|
||||
* Please refer the following link to get more information abour this project
|
||||
https://launchpad.net/openstack-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 XML files related to Associate
|
||||
Training Guide.
|
||||
2. operator-guide: This folder contains XML files related to Operator
|
||||
Training Guide.
|
||||
3. developer-guide: This folder contains XML files related to Developer
|
||||
Training Guide.
|
||||
4. architect-guide: This folder contains XML files related to Architect
|
||||
Training Guide.
|
||||
5. basic-install-guide: This folder contains Install Guides which is
|
||||
similar to basic/easy version of Install Guides present under
|
||||
openstack-manuals.
|
||||
6. common: This folder contains common files used by multiple training
|
||||
guides.
|
||||
7. figures: This folder contains images used by all the training guides.
|
||||
10
doc/training-guides/architect-guide/README.md
Normal file
10
doc/training-guides/architect-guide/README.md
Normal file
@ -0,0 +1,10 @@
|
||||
Introduction
|
||||
============
|
||||
|
||||
* This folder contains the XML files related to Architect Training Guide.
|
||||
* 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
|
||||
10
doc/training-guides/associate-guide/README.md
Normal file
10
doc/training-guides/associate-guide/README.md
Normal file
@ -0,0 +1,10 @@
|
||||
Introduction
|
||||
============
|
||||
|
||||
* This folder contains the XML files related to Associate Training Guide.
|
||||
* 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
|
||||
13
doc/training-guides/basic-install-guide/README.md
Normal file
13
doc/training-guides/basic-install-guide/README.md
Normal file
@ -0,0 +1,13 @@
|
||||
Introduction
|
||||
============
|
||||
|
||||
* This folder contains the XML files related to Basic Install Guide.
|
||||
* Refer to the following etherpad for more details on the design and planning
|
||||
for the basic install guide section.
|
||||
https://etherpad.openstack.org/p/training-guides-install-guide
|
||||
* 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
|
||||
14
doc/training-guides/common/README.md
Normal file
14
doc/training-guides/common/README.md
Normal file
@ -0,0 +1,14 @@
|
||||
Introduction
|
||||
============
|
||||
|
||||
* This folder contains the XML files commonly used by all the other Training
|
||||
Guides.
|
||||
* If you feel that the XML files in this section can be re-used for other books
|
||||
under OpenStack-Manuals, you may move them to common folder located in
|
||||
OpenStack-Manuals.
|
||||
* 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
|
||||
10
doc/training-guides/developer-guide/README.md
Normal file
10
doc/training-guides/developer-guide/README.md
Normal file
@ -0,0 +1,10 @@
|
||||
Introduction
|
||||
============
|
||||
|
||||
* This folder contains the XML files related to Developer Training Guide.
|
||||
* 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
|
||||
15
doc/training-guides/figures/README.md
Normal file
15
doc/training-guides/figures/README.md
Normal file
@ -0,0 +1,15 @@
|
||||
Introduction
|
||||
============
|
||||
|
||||
* This folder contains the images/snapshots/diagrams required by training
|
||||
guides.
|
||||
* Please try to push images which are SVG/Vector Graphics format.
|
||||
* Call for **help**, if you think you can port existing jpg/png (raster
|
||||
graphics formatted images) to svg or similar vector graphics format, please
|
||||
feel free to contribute.
|
||||
* 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
|
||||
10
doc/training-guides/operator-guide/README.md
Normal file
10
doc/training-guides/operator-guide/README.md
Normal file
@ -0,0 +1,10 @@
|
||||
Introduction
|
||||
============
|
||||
|
||||
* This folder contains the XML files related to Operator Training Guide.
|
||||
* 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
|
||||
Loading…
x
Reference in New Issue
Block a user