diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..68c771a0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,176 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..7a399104 --- /dev/null +++ b/README.rst @@ -0,0 +1,97 @@ +OpenStack Manuals ++++++++++++++++++ + +This repository contains open source training manuals that can be +used to learn about the OpenStack project. + +For more details, see the `OpenStack Training Guides wiki page +`_. + +It includes these guides: + + * Associate Guide + * Operator Guide + * Developer Guide + + +Prerequisites +============= +`Apache Maven `_ must be installed to build the +documentation. + +To install Maven 3 for Ubuntu 12.04 and later, and Debian wheezy and later:: + + apt-get install maven + +On Fedora 15 and later:: + + yum install maven3 + +Building +======== +The different guides are in subdirectories of the +``openstack-training-guides/doc/`` directory. + +To build the guides, look for a ``pom.xml`` file within a subdirectory, +then run the ``mvn`` command in that directory. For example:: + + cd openstack-training-guides/doc/training-guides/ + mvn clean generate-sources + +The generated PDF documentation file is:: + + openstack-training-guides/doc/training-guides/target/docbkx/webhelp/training-guides.pdf + +The root of the generated HTML documentation is:: + + openstack-training-guides/doc/training-guides/target/docbkx/webhelp/training-guides/content/index.html + +Testing of changes and building of the manual +============================================= + +Install the python tox package and run ``tox`` from the top-level +directory to use the same tests that are done as part of our Jenkins +gating jobs. + +If you like to run individual tests, run: + + * ``tox -e checkniceness`` - to run the niceness tests + * ``tox -e checksyntax`` - to run syntax checks + * ``tox -e checkdeletions`` - to check that no deleted files are referenced + * ``tox -e checkbuild`` - to actually build the manual + +tox will use the openstack-doc-tools package for execution of these +tests. + + +Contributing +============ + +Our community welcomes all people interested in open source cloud +computing, and encourages you to join the `OpenStack Foundation +`_. + +The best way to get involved with the community is to talk with others +online or at a meet up and offer contributions through our processes, +the `OpenStack wiki `_, blogs, or on IRC at +``#openstack`` on ``irc.freenode.net``. + +We welcome all types of contributions, from blueprint designs to +documentation to testing to deployment scripts. + +If you would like to contribute to the documents, please see the +`Documentation HowTo `_. + + +Bugs +==== + +Bugs should be filed on Launchpad, not GitHub: + + https://bugs.launchpad.net/openstack-training-guides + + +Installing +========== +Refer to http://docs.openstack.org to see where these documents are published +and to learn more about the OpenStack project. diff --git a/doc-test.conf b/doc-test.conf new file mode 100644 index 00000000..d81352ab --- /dev/null +++ b/doc-test.conf @@ -0,0 +1,10 @@ +[DEFAULT] +repo_name = openstack-training-guides + +# These files are not in DocBook format: +#file_exception = + +# This file does not pass our syntax checks for valid Docbook XML. +# Let's ignore it for now. +file_exception = st-training-guides.xml + diff --git a/bk000-preface.xml b/doc/training-guides/bk000-preface.xml similarity index 100% rename from bk000-preface.xml rename to doc/training-guides/bk000-preface.xml diff --git a/bk001-associate-training-guide.xml b/doc/training-guides/bk001-associate-training-guide.xml similarity index 100% rename from bk001-associate-training-guide.xml rename to doc/training-guides/bk001-associate-training-guide.xml diff --git a/bk001-bk010-associate-object-storage-node-quiz.xml b/doc/training-guides/bk001-bk010-associate-object-storage-node-quiz.xml similarity index 100% rename from bk001-bk010-associate-object-storage-node-quiz.xml rename to doc/training-guides/bk001-bk010-associate-object-storage-node-quiz.xml diff --git a/bk001-ch001-associate-getting-started.xml b/doc/training-guides/bk001-ch001-associate-getting-started.xml similarity index 100% rename from bk001-ch001-associate-getting-started.xml rename to doc/training-guides/bk001-ch001-associate-getting-started.xml diff --git a/bk001-ch002-associate-getting-started-quiz.xml b/doc/training-guides/bk001-ch002-associate-getting-started-quiz.xml similarity index 100% rename from bk001-ch002-associate-getting-started-quiz.xml rename to doc/training-guides/bk001-ch002-associate-getting-started-quiz.xml diff --git a/bk001-ch003-associate-controller-node.xml b/doc/training-guides/bk001-ch003-associate-controller-node.xml similarity index 100% rename from bk001-ch003-associate-controller-node.xml rename to doc/training-guides/bk001-ch003-associate-controller-node.xml diff --git a/bk001-ch004-associate-controller-node-quiz.xml b/doc/training-guides/bk001-ch004-associate-controller-node-quiz.xml similarity index 100% rename from bk001-ch004-associate-controller-node-quiz.xml rename to doc/training-guides/bk001-ch004-associate-controller-node-quiz.xml diff --git a/bk001-ch005-associate-compute-node.xml b/doc/training-guides/bk001-ch005-associate-compute-node.xml similarity index 100% rename from bk001-ch005-associate-compute-node.xml rename to doc/training-guides/bk001-ch005-associate-compute-node.xml diff --git a/bk001-ch006-associate-compute-node-quiz.xml b/doc/training-guides/bk001-ch006-associate-compute-node-quiz.xml similarity index 100% rename from bk001-ch006-associate-compute-node-quiz.xml rename to doc/training-guides/bk001-ch006-associate-compute-node-quiz.xml diff --git a/bk001-ch007-associate-network-node.xml b/doc/training-guides/bk001-ch007-associate-network-node.xml similarity index 100% rename from bk001-ch007-associate-network-node.xml rename to doc/training-guides/bk001-ch007-associate-network-node.xml diff --git a/bk001-ch008-associate-network-node-quiz.xml b/doc/training-guides/bk001-ch008-associate-network-node-quiz.xml similarity index 100% rename from bk001-ch008-associate-network-node-quiz.xml rename to doc/training-guides/bk001-ch008-associate-network-node-quiz.xml diff --git a/bk001-ch009-associate-object-storage-node.xml b/doc/training-guides/bk001-ch009-associate-object-storage-node.xml similarity index 100% rename from bk001-ch009-associate-object-storage-node.xml rename to doc/training-guides/bk001-ch009-associate-object-storage-node.xml diff --git a/bk001-ch011-associate-assessment.xml b/doc/training-guides/bk001-ch011-associate-assessment.xml similarity index 100% rename from bk001-ch011-associate-assessment.xml rename to doc/training-guides/bk001-ch011-associate-assessment.xml diff --git a/bk001-ch012-associate-review-concept.xml b/doc/training-guides/bk001-ch012-associate-review-concept.xml similarity index 100% rename from bk001-ch012-associate-review-concept.xml rename to doc/training-guides/bk001-ch012-associate-review-concept.xml diff --git a/bk002-ch001-operator-getting-started.xml b/doc/training-guides/bk002-ch001-operator-getting-started.xml similarity index 100% rename from bk002-ch001-operator-getting-started.xml rename to doc/training-guides/bk002-ch001-operator-getting-started.xml diff --git a/bk002-ch002-operator-getting-started-lab.xml b/doc/training-guides/bk002-ch002-operator-getting-started-lab.xml similarity index 100% rename from bk002-ch002-operator-getting-started-lab.xml rename to doc/training-guides/bk002-ch002-operator-getting-started-lab.xml diff --git a/bk002-ch003-operator-getting-started-quiz.xml b/doc/training-guides/bk002-ch003-operator-getting-started-quiz.xml similarity index 100% rename from bk002-ch003-operator-getting-started-quiz.xml rename to doc/training-guides/bk002-ch003-operator-getting-started-quiz.xml diff --git a/bk002-ch004-operator-controller-node.xml b/doc/training-guides/bk002-ch004-operator-controller-node.xml similarity index 100% rename from bk002-ch004-operator-controller-node.xml rename to doc/training-guides/bk002-ch004-operator-controller-node.xml diff --git a/bk002-ch005-operator-controller-node-lab.xml b/doc/training-guides/bk002-ch005-operator-controller-node-lab.xml similarity index 100% rename from bk002-ch005-operator-controller-node-lab.xml rename to doc/training-guides/bk002-ch005-operator-controller-node-lab.xml diff --git a/bk002-ch006-operator-controller-node-quiz.xml b/doc/training-guides/bk002-ch006-operator-controller-node-quiz.xml similarity index 100% rename from bk002-ch006-operator-controller-node-quiz.xml rename to doc/training-guides/bk002-ch006-operator-controller-node-quiz.xml diff --git a/bk002-ch007-operator-compute-node.xml b/doc/training-guides/bk002-ch007-operator-compute-node.xml similarity index 100% rename from bk002-ch007-operator-compute-node.xml rename to doc/training-guides/bk002-ch007-operator-compute-node.xml diff --git a/bk002-ch008-operator-compute-node-lab.xml b/doc/training-guides/bk002-ch008-operator-compute-node-lab.xml similarity index 100% rename from bk002-ch008-operator-compute-node-lab.xml rename to doc/training-guides/bk002-ch008-operator-compute-node-lab.xml diff --git a/bk002-ch009-operator-compute-node-quiz.xml b/doc/training-guides/bk002-ch009-operator-compute-node-quiz.xml similarity index 100% rename from bk002-ch009-operator-compute-node-quiz.xml rename to doc/training-guides/bk002-ch009-operator-compute-node-quiz.xml diff --git a/bk002-ch010-operator-network-node.xml b/doc/training-guides/bk002-ch010-operator-network-node.xml similarity index 100% rename from bk002-ch010-operator-network-node.xml rename to doc/training-guides/bk002-ch010-operator-network-node.xml diff --git a/bk002-ch011-operator-network-node-lab.xml b/doc/training-guides/bk002-ch011-operator-network-node-lab.xml similarity index 100% rename from bk002-ch011-operator-network-node-lab.xml rename to doc/training-guides/bk002-ch011-operator-network-node-lab.xml diff --git a/bk002-ch012-operator-network-node-quiz.xml b/doc/training-guides/bk002-ch012-operator-network-node-quiz.xml similarity index 100% rename from bk002-ch012-operator-network-node-quiz.xml rename to doc/training-guides/bk002-ch012-operator-network-node-quiz.xml diff --git a/bk002-ch013-operator-object-storage-node.xml b/doc/training-guides/bk002-ch013-operator-object-storage-node.xml similarity index 100% rename from bk002-ch013-operator-object-storage-node.xml rename to doc/training-guides/bk002-ch013-operator-object-storage-node.xml diff --git a/bk002-ch014-operator-object-storage-node-lab.xml b/doc/training-guides/bk002-ch014-operator-object-storage-node-lab.xml similarity index 100% rename from bk002-ch014-operator-object-storage-node-lab.xml rename to doc/training-guides/bk002-ch014-operator-object-storage-node-lab.xml diff --git a/bk002-ch015-operator-object-storage-node-quiz.xml b/doc/training-guides/bk002-ch015-operator-object-storage-node-quiz.xml similarity index 100% rename from bk002-ch015-operator-object-storage-node-quiz.xml rename to doc/training-guides/bk002-ch015-operator-object-storage-node-quiz.xml diff --git a/bk002-operator-training-guide.xml b/doc/training-guides/bk002-operator-training-guide.xml similarity index 100% rename from bk002-operator-training-guide.xml rename to doc/training-guides/bk002-operator-training-guide.xml diff --git a/bk003-ch001-developer-getting-started.xml b/doc/training-guides/bk003-ch001-developer-getting-started.xml similarity index 100% rename from bk003-ch001-developer-getting-started.xml rename to doc/training-guides/bk003-ch001-developer-getting-started.xml diff --git a/bk003-ch002-developer-getting-started-lab.xml b/doc/training-guides/bk003-ch002-developer-getting-started-lab.xml similarity index 100% rename from bk003-ch002-developer-getting-started-lab.xml rename to doc/training-guides/bk003-ch002-developer-getting-started-lab.xml diff --git a/bk003-ch003-developer-getting-started-quiz.xml b/doc/training-guides/bk003-ch003-developer-getting-started-quiz.xml similarity index 100% rename from bk003-ch003-developer-getting-started-quiz.xml rename to doc/training-guides/bk003-ch003-developer-getting-started-quiz.xml diff --git a/bk003-ch004-developer-apis-in-depth.xml b/doc/training-guides/bk003-ch004-developer-apis-in-depth.xml similarity index 100% rename from bk003-ch004-developer-apis-in-depth.xml rename to doc/training-guides/bk003-ch004-developer-apis-in-depth.xml diff --git a/bk003-ch005-developer-apis-day-two-lab.xml b/doc/training-guides/bk003-ch005-developer-apis-day-two-lab.xml similarity index 100% rename from bk003-ch005-developer-apis-day-two-lab.xml rename to doc/training-guides/bk003-ch005-developer-apis-day-two-lab.xml diff --git a/bk003-ch006-developer-apis-day-two-quiz.xml b/doc/training-guides/bk003-ch006-developer-apis-day-two-quiz.xml similarity index 100% rename from bk003-ch006-developer-apis-day-two-quiz.xml rename to doc/training-guides/bk003-ch006-developer-apis-day-two-quiz.xml diff --git a/bk003-ch007-developer-apis-day-three-lab.xml b/doc/training-guides/bk003-ch007-developer-apis-day-three-lab.xml similarity index 100% rename from bk003-ch007-developer-apis-day-three-lab.xml rename to doc/training-guides/bk003-ch007-developer-apis-day-three-lab.xml diff --git a/bk003-ch008-developer-apis-day-three-quiz.xml b/doc/training-guides/bk003-ch008-developer-apis-day-three-quiz.xml similarity index 100% rename from bk003-ch008-developer-apis-day-three-quiz.xml rename to doc/training-guides/bk003-ch008-developer-apis-day-three-quiz.xml diff --git a/bk003-ch009-developer-apis-day-four-lab.xml b/doc/training-guides/bk003-ch009-developer-apis-day-four-lab.xml similarity index 100% rename from bk003-ch009-developer-apis-day-four-lab.xml rename to doc/training-guides/bk003-ch009-developer-apis-day-four-lab.xml diff --git a/bk003-ch010-developer-apis-day-four-quiz.xml b/doc/training-guides/bk003-ch010-developer-apis-day-four-quiz.xml similarity index 100% rename from bk003-ch010-developer-apis-day-four-quiz.xml rename to doc/training-guides/bk003-ch010-developer-apis-day-four-quiz.xml diff --git a/bk003-ch011-developer-how-to-partipate.xml b/doc/training-guides/bk003-ch011-developer-how-to-partipate.xml similarity index 100% rename from bk003-ch011-developer-how-to-partipate.xml rename to doc/training-guides/bk003-ch011-developer-how-to-partipate.xml diff --git a/bk003-ch012-developer-how-to-participate-day-five-lab.xml b/doc/training-guides/bk003-ch012-developer-how-to-participate-day-five-lab.xml similarity index 100% rename from bk003-ch012-developer-how-to-participate-day-five-lab.xml rename to doc/training-guides/bk003-ch012-developer-how-to-participate-day-five-lab.xml diff --git a/bk003-ch013-developer-how-to-participate-day-five-quiz.xml b/doc/training-guides/bk003-ch013-developer-how-to-participate-day-five-quiz.xml similarity index 100% rename from bk003-ch013-developer-how-to-participate-day-five-quiz.xml rename to doc/training-guides/bk003-ch013-developer-how-to-participate-day-five-quiz.xml diff --git a/bk003-ch014-developer-how-to-participate-day-six-lab.xml b/doc/training-guides/bk003-ch014-developer-how-to-participate-day-six-lab.xml similarity index 100% rename from bk003-ch014-developer-how-to-participate-day-six-lab.xml rename to doc/training-guides/bk003-ch014-developer-how-to-participate-day-six-lab.xml diff --git a/bk003-ch015-developer-how-to-participate-day-six-quiz.xml b/doc/training-guides/bk003-ch015-developer-how-to-participate-day-six-quiz.xml similarity index 100% rename from bk003-ch015-developer-how-to-participate-day-six-quiz.xml rename to doc/training-guides/bk003-ch015-developer-how-to-participate-day-six-quiz.xml diff --git a/bk003-ch016-developer-how-to-participate-day-seven-lab.xml b/doc/training-guides/bk003-ch016-developer-how-to-participate-day-seven-lab.xml similarity index 100% rename from bk003-ch016-developer-how-to-participate-day-seven-lab.xml rename to doc/training-guides/bk003-ch016-developer-how-to-participate-day-seven-lab.xml diff --git a/bk003-ch017-developer-how-to-participate-day-seven-quiz.xml b/doc/training-guides/bk003-ch017-developer-how-to-participate-day-seven-quiz.xml similarity index 100% rename from bk003-ch017-developer-how-to-participate-day-seven-quiz.xml rename to doc/training-guides/bk003-ch017-developer-how-to-participate-day-seven-quiz.xml diff --git a/bk003-ch018-developer-how-to-participate-day-eight-lab.xml b/doc/training-guides/bk003-ch018-developer-how-to-participate-day-eight-lab.xml similarity index 100% rename from bk003-ch018-developer-how-to-participate-day-eight-lab.xml rename to doc/training-guides/bk003-ch018-developer-how-to-participate-day-eight-lab.xml diff --git a/bk003-ch019-developer-how-to-participate-day-eight-quiz.xml b/doc/training-guides/bk003-ch019-developer-how-to-participate-day-eight-quiz.xml similarity index 100% rename from bk003-ch019-developer-how-to-participate-day-eight-quiz.xml rename to doc/training-guides/bk003-ch019-developer-how-to-participate-day-eight-quiz.xml diff --git a/bk003-ch020-developer-how-to-participate-day-nine-lab.xml b/doc/training-guides/bk003-ch020-developer-how-to-participate-day-nine-lab.xml similarity index 100% rename from bk003-ch020-developer-how-to-participate-day-nine-lab.xml rename to doc/training-guides/bk003-ch020-developer-how-to-participate-day-nine-lab.xml diff --git a/bk003-ch021-developer-how-to-participate-day-nine-quiz.xml b/doc/training-guides/bk003-ch021-developer-how-to-participate-day-nine-quiz.xml similarity index 100% rename from bk003-ch021-developer-how-to-participate-day-nine-quiz.xml rename to doc/training-guides/bk003-ch021-developer-how-to-participate-day-nine-quiz.xml diff --git a/bk003-ch022-developer-assessment.xml b/doc/training-guides/bk003-ch022-developer-assessment.xml similarity index 100% rename from bk003-ch022-developer-assessment.xml rename to doc/training-guides/bk003-ch022-developer-assessment.xml diff --git a/bk003-ch023-developer-how-to-participate-bootcamp.xml b/doc/training-guides/bk003-ch023-developer-how-to-participate-bootcamp.xml similarity index 100% rename from bk003-ch023-developer-how-to-participate-bootcamp.xml rename to doc/training-guides/bk003-ch023-developer-how-to-participate-bootcamp.xml diff --git a/bk003-developer-training-guide.xml b/doc/training-guides/bk003-developer-training-guide.xml similarity index 100% rename from bk003-developer-training-guide.xml rename to doc/training-guides/bk003-developer-training-guide.xml diff --git a/bk004-architect-training-guide.xml b/doc/training-guides/bk004-architect-training-guide.xml similarity index 100% rename from bk004-architect-training-guide.xml rename to doc/training-guides/bk004-architect-training-guide.xml diff --git a/card007-core-overview.xml b/doc/training-guides/card007-core-overview.xml similarity index 100% rename from card007-core-overview.xml rename to doc/training-guides/card007-core-overview.xml diff --git a/card008.xml b/doc/training-guides/card008.xml similarity index 100% rename from card008.xml rename to doc/training-guides/card008.xml diff --git a/card009.xml b/doc/training-guides/card009.xml similarity index 100% rename from card009.xml rename to doc/training-guides/card009.xml diff --git a/card011.xml b/doc/training-guides/card011.xml similarity index 100% rename from card011.xml rename to doc/training-guides/card011.xml diff --git a/card025.xml b/doc/training-guides/card025.xml similarity index 100% rename from card025.xml rename to doc/training-guides/card025.xml diff --git a/card026-network-node-architecture.xml b/doc/training-guides/card026-network-node-architecture.xml similarity index 100% rename from card026-network-node-architecture.xml rename to doc/training-guides/card026-network-node-architecture.xml diff --git a/card037-rabbitmq.xml b/doc/training-guides/card037-rabbitmq.xml similarity index 100% rename from card037-rabbitmq.xml rename to doc/training-guides/card037-rabbitmq.xml diff --git a/card038.xml b/doc/training-guides/card038.xml similarity index 100% rename from card038.xml rename to doc/training-guides/card038.xml diff --git a/card039-nova.xml b/doc/training-guides/card039-nova.xml similarity index 100% rename from card039-nova.xml rename to doc/training-guides/card039-nova.xml diff --git a/card040-cinder.xml b/doc/training-guides/card040-cinder.xml similarity index 100% rename from card040-cinder.xml rename to doc/training-guides/card040-cinder.xml diff --git a/card041-neutron.xml b/doc/training-guides/card041-neutron.xml similarity index 100% rename from card041-neutron.xml rename to doc/training-guides/card041-neutron.xml diff --git a/card043-ovs-in-network-node.xml b/doc/training-guides/card043-ovs-in-network-node.xml similarity index 100% rename from card043-ovs-in-network-node.xml rename to doc/training-guides/card043-ovs-in-network-node.xml diff --git a/card044-install-and-configure-neutron-network-node.xml b/doc/training-guides/card044-install-and-configure-neutron-network-node.xml similarity index 100% rename from card044-install-and-configure-neutron-network-node.xml rename to doc/training-guides/card044-install-and-configure-neutron-network-node.xml diff --git a/card045-configure-virtual-networking.xml b/doc/training-guides/card045-configure-virtual-networking.xml similarity index 100% rename from card045-configure-virtual-networking.xml rename to doc/training-guides/card045-configure-virtual-networking.xml diff --git a/card046-L3_Configuration_in_the_Network_Node.xml b/doc/training-guides/card046-L3_Configuration_in_the_Network_Node.xml similarity index 100% rename from card046-L3_Configuration_in_the_Network_Node.xml rename to doc/training-guides/card046-L3_Configuration_in_the_Network_Node.xml diff --git a/card047-install-nova-compute.xml b/doc/training-guides/card047-install-nova-compute.xml similarity index 100% rename from card047-install-nova-compute.xml rename to doc/training-guides/card047-install-nova-compute.xml diff --git a/card070-create-floating-ips.xml b/doc/training-guides/card070-create-floating-ips.xml similarity index 100% rename from card070-create-floating-ips.xml rename to doc/training-guides/card070-create-floating-ips.xml diff --git a/card071-create-cinder-horizon.xml b/doc/training-guides/card071-create-cinder-horizon.xml similarity index 100% rename from card071-create-cinder-horizon.xml rename to doc/training-guides/card071-create-cinder-horizon.xml diff --git a/card072-cinder-attach-volume.xml b/doc/training-guides/card072-cinder-attach-volume.xml similarity index 100% rename from card072-cinder-attach-volume.xml rename to doc/training-guides/card072-cinder-attach-volume.xml diff --git a/card073-control-state-instance.xml b/doc/training-guides/card073-control-state-instance.xml similarity index 100% rename from card073-control-state-instance.xml rename to doc/training-guides/card073-control-state-instance.xml diff --git a/card074-horizon-snapshots.xml b/doc/training-guides/card074-horizon-snapshots.xml similarity index 100% rename from card074-horizon-snapshots.xml rename to doc/training-guides/card074-horizon-snapshots.xml diff --git a/card126-horizon.xml b/doc/training-guides/card126-horizon.xml similarity index 100% rename from card126-horizon.xml rename to doc/training-guides/card126-horizon.xml diff --git a/card127-glance.xml b/doc/training-guides/card127-glance.xml similarity index 100% rename from card127-glance.xml rename to doc/training-guides/card127-glance.xml diff --git a/card128-swift.xml b/doc/training-guides/card128-swift.xml similarity index 100% rename from card128-swift.xml rename to doc/training-guides/card128-swift.xml diff --git a/figures/image00.png b/doc/training-guides/figures/image00.png similarity index 100% rename from figures/image00.png rename to doc/training-guides/figures/image00.png diff --git a/figures/image01.png b/doc/training-guides/figures/image01.png similarity index 100% rename from figures/image01.png rename to doc/training-guides/figures/image01.png diff --git a/figures/image02.png b/doc/training-guides/figures/image02.png similarity index 100% rename from figures/image02.png rename to doc/training-guides/figures/image02.png diff --git a/figures/image03.png b/doc/training-guides/figures/image03.png similarity index 100% rename from figures/image03.png rename to doc/training-guides/figures/image03.png diff --git a/figures/image04.png b/doc/training-guides/figures/image04.png similarity index 100% rename from figures/image04.png rename to doc/training-guides/figures/image04.png diff --git a/figures/image05.png b/doc/training-guides/figures/image05.png similarity index 100% rename from figures/image05.png rename to doc/training-guides/figures/image05.png diff --git a/figures/image06.png b/doc/training-guides/figures/image06.png similarity index 100% rename from figures/image06.png rename to doc/training-guides/figures/image06.png diff --git a/figures/image08.png b/doc/training-guides/figures/image08.png similarity index 100% rename from figures/image08.png rename to doc/training-guides/figures/image08.png diff --git a/figures/image09.png b/doc/training-guides/figures/image09.png similarity index 100% rename from figures/image09.png rename to doc/training-guides/figures/image09.png diff --git a/figures/image10.jpg b/doc/training-guides/figures/image10.jpg similarity index 100% rename from figures/image10.jpg rename to doc/training-guides/figures/image10.jpg diff --git a/figures/image11.png b/doc/training-guides/figures/image11.png similarity index 100% rename from figures/image11.png rename to doc/training-guides/figures/image11.png diff --git a/figures/image12.png b/doc/training-guides/figures/image12.png similarity index 100% rename from figures/image12.png rename to doc/training-guides/figures/image12.png diff --git a/figures/image13.jpg b/doc/training-guides/figures/image13.jpg similarity index 100% rename from figures/image13.jpg rename to doc/training-guides/figures/image13.jpg diff --git a/figures/image14.png b/doc/training-guides/figures/image14.png similarity index 100% rename from figures/image14.png rename to doc/training-guides/figures/image14.png diff --git a/figures/image15.png b/doc/training-guides/figures/image15.png similarity index 100% rename from figures/image15.png rename to doc/training-guides/figures/image15.png diff --git a/figures/image16.png b/doc/training-guides/figures/image16.png similarity index 100% rename from figures/image16.png rename to doc/training-guides/figures/image16.png diff --git a/figures/image17.png b/doc/training-guides/figures/image17.png similarity index 100% rename from figures/image17.png rename to doc/training-guides/figures/image17.png diff --git a/figures/image19.png b/doc/training-guides/figures/image19.png similarity index 100% rename from figures/image19.png rename to doc/training-guides/figures/image19.png diff --git a/figures/image20.png b/doc/training-guides/figures/image20.png similarity index 100% rename from figures/image20.png rename to doc/training-guides/figures/image20.png diff --git a/figures/image21.png b/doc/training-guides/figures/image21.png similarity index 100% rename from figures/image21.png rename to doc/training-guides/figures/image21.png diff --git a/figures/image22.png b/doc/training-guides/figures/image22.png similarity index 100% rename from figures/image22.png rename to doc/training-guides/figures/image22.png diff --git a/figures/image23.jpg b/doc/training-guides/figures/image23.jpg similarity index 100% rename from figures/image23.jpg rename to doc/training-guides/figures/image23.jpg diff --git a/figures/image24.png b/doc/training-guides/figures/image24.png similarity index 100% rename from figures/image24.png rename to doc/training-guides/figures/image24.png diff --git a/figures/image25.png b/doc/training-guides/figures/image25.png similarity index 100% rename from figures/image25.png rename to doc/training-guides/figures/image25.png diff --git a/figures/image26.png b/doc/training-guides/figures/image26.png similarity index 100% rename from figures/image26.png rename to doc/training-guides/figures/image26.png diff --git a/figures/image27.png b/doc/training-guides/figures/image27.png similarity index 100% rename from figures/image27.png rename to doc/training-guides/figures/image27.png diff --git a/figures/image28.png b/doc/training-guides/figures/image28.png similarity index 100% rename from figures/image28.png rename to doc/training-guides/figures/image28.png diff --git a/figures/image29.png b/doc/training-guides/figures/image29.png similarity index 100% rename from figures/image29.png rename to doc/training-guides/figures/image29.png diff --git a/figures/image30.png b/doc/training-guides/figures/image30.png similarity index 100% rename from figures/image30.png rename to doc/training-guides/figures/image30.png diff --git a/figures/image32.png b/doc/training-guides/figures/image32.png similarity index 100% rename from figures/image32.png rename to doc/training-guides/figures/image32.png diff --git a/figures/image33.png b/doc/training-guides/figures/image33.png similarity index 100% rename from figures/image33.png rename to doc/training-guides/figures/image33.png diff --git a/figures/image34.png b/doc/training-guides/figures/image34.png similarity index 100% rename from figures/image34.png rename to doc/training-guides/figures/image34.png diff --git a/figures/image35.png b/doc/training-guides/figures/image35.png similarity index 100% rename from figures/image35.png rename to doc/training-guides/figures/image35.png diff --git a/figures/image36.png b/doc/training-guides/figures/image36.png similarity index 100% rename from figures/image36.png rename to doc/training-guides/figures/image36.png diff --git a/figures/image37.png b/doc/training-guides/figures/image37.png similarity index 100% rename from figures/image37.png rename to doc/training-guides/figures/image37.png diff --git a/figures/image38.png b/doc/training-guides/figures/image38.png similarity index 100% rename from figures/image38.png rename to doc/training-guides/figures/image38.png diff --git a/figures/image39.png b/doc/training-guides/figures/image39.png similarity index 100% rename from figures/image39.png rename to doc/training-guides/figures/image39.png diff --git a/figures/image40.png b/doc/training-guides/figures/image40.png similarity index 100% rename from figures/image40.png rename to doc/training-guides/figures/image40.png diff --git a/figures/image41.png b/doc/training-guides/figures/image41.png similarity index 100% rename from figures/image41.png rename to doc/training-guides/figures/image41.png diff --git a/figures/image42.png b/doc/training-guides/figures/image42.png similarity index 100% rename from figures/image42.png rename to doc/training-guides/figures/image42.png diff --git a/figures/image43.png b/doc/training-guides/figures/image43.png similarity index 100% rename from figures/image43.png rename to doc/training-guides/figures/image43.png diff --git a/figures/image44.png b/doc/training-guides/figures/image44.png similarity index 100% rename from figures/image44.png rename to doc/training-guides/figures/image44.png diff --git a/figures/image45.png b/doc/training-guides/figures/image45.png similarity index 100% rename from figures/image45.png rename to doc/training-guides/figures/image45.png diff --git a/figures/image46.png b/doc/training-guides/figures/image46.png similarity index 100% rename from figures/image46.png rename to doc/training-guides/figures/image46.png diff --git a/figures/image47.png b/doc/training-guides/figures/image47.png similarity index 100% rename from figures/image47.png rename to doc/training-guides/figures/image47.png diff --git a/figures/image48.png b/doc/training-guides/figures/image48.png similarity index 100% rename from figures/image48.png rename to doc/training-guides/figures/image48.png diff --git a/figures/lab000-virtual-box/image00.png b/doc/training-guides/figures/lab000-virtual-box/image00.png similarity index 100% rename from figures/lab000-virtual-box/image00.png rename to doc/training-guides/figures/lab000-virtual-box/image00.png diff --git a/figures/lab000-virtual-box/image01.png b/doc/training-guides/figures/lab000-virtual-box/image01.png similarity index 100% rename from figures/lab000-virtual-box/image01.png rename to doc/training-guides/figures/lab000-virtual-box/image01.png diff --git a/figures/lab000-virtual-box/image02.png b/doc/training-guides/figures/lab000-virtual-box/image02.png similarity index 100% rename from figures/lab000-virtual-box/image02.png rename to doc/training-guides/figures/lab000-virtual-box/image02.png diff --git a/figures/lab000-virtual-box/image03.png b/doc/training-guides/figures/lab000-virtual-box/image03.png similarity index 100% rename from figures/lab000-virtual-box/image03.png rename to doc/training-guides/figures/lab000-virtual-box/image03.png diff --git a/figures/lab000-virtual-box/image04.png b/doc/training-guides/figures/lab000-virtual-box/image04.png similarity index 100% rename from figures/lab000-virtual-box/image04.png rename to doc/training-guides/figures/lab000-virtual-box/image04.png diff --git a/figures/lab000-virtual-box/image05.png b/doc/training-guides/figures/lab000-virtual-box/image05.png similarity index 100% rename from figures/lab000-virtual-box/image05.png rename to doc/training-guides/figures/lab000-virtual-box/image05.png diff --git a/figures/lab000-virtual-box/image07.png b/doc/training-guides/figures/lab000-virtual-box/image07.png similarity index 100% rename from figures/lab000-virtual-box/image07.png rename to doc/training-guides/figures/lab000-virtual-box/image07.png diff --git a/figures/lab000-virtual-box/image08.png b/doc/training-guides/figures/lab000-virtual-box/image08.png similarity index 100% rename from figures/lab000-virtual-box/image08.png rename to doc/training-guides/figures/lab000-virtual-box/image08.png diff --git a/figures/lab000-virtual-box/image09.png b/doc/training-guides/figures/lab000-virtual-box/image09.png similarity index 100% rename from figures/lab000-virtual-box/image09.png rename to doc/training-guides/figures/lab000-virtual-box/image09.png diff --git a/figures/lab000-virtual-box/image10.png b/doc/training-guides/figures/lab000-virtual-box/image10.png similarity index 100% rename from figures/lab000-virtual-box/image10.png rename to doc/training-guides/figures/lab000-virtual-box/image10.png diff --git a/figures/lab000-virtual-box/image11.png b/doc/training-guides/figures/lab000-virtual-box/image11.png similarity index 100% rename from figures/lab000-virtual-box/image11.png rename to doc/training-guides/figures/lab000-virtual-box/image11.png diff --git a/figures/lab000-virtual-box/image12.png b/doc/training-guides/figures/lab000-virtual-box/image12.png similarity index 100% rename from figures/lab000-virtual-box/image12.png rename to doc/training-guides/figures/lab000-virtual-box/image12.png diff --git a/figures/lab000-virtual-box/image13.png b/doc/training-guides/figures/lab000-virtual-box/image13.png similarity index 100% rename from figures/lab000-virtual-box/image13.png rename to doc/training-guides/figures/lab000-virtual-box/image13.png diff --git a/figures/lab000-virtual-box/image14.png b/doc/training-guides/figures/lab000-virtual-box/image14.png similarity index 100% rename from figures/lab000-virtual-box/image14.png rename to doc/training-guides/figures/lab000-virtual-box/image14.png diff --git a/figures/lab000-virtual-box/image15.png b/doc/training-guides/figures/lab000-virtual-box/image15.png similarity index 100% rename from figures/lab000-virtual-box/image15.png rename to doc/training-guides/figures/lab000-virtual-box/image15.png diff --git a/figures/lab000-virtual-box/image16.png b/doc/training-guides/figures/lab000-virtual-box/image16.png similarity index 100% rename from figures/lab000-virtual-box/image16.png rename to doc/training-guides/figures/lab000-virtual-box/image16.png diff --git a/figures/lab000-virtual-box/image17.png b/doc/training-guides/figures/lab000-virtual-box/image17.png similarity index 100% rename from figures/lab000-virtual-box/image17.png rename to doc/training-guides/figures/lab000-virtual-box/image17.png diff --git a/figures/lab000-virtual-box/image18.png b/doc/training-guides/figures/lab000-virtual-box/image18.png similarity index 100% rename from figures/lab000-virtual-box/image18.png rename to doc/training-guides/figures/lab000-virtual-box/image18.png diff --git a/figures/lab000-virtual-box/image19.png b/doc/training-guides/figures/lab000-virtual-box/image19.png similarity index 100% rename from figures/lab000-virtual-box/image19.png rename to doc/training-guides/figures/lab000-virtual-box/image19.png diff --git a/figures/openstack-arch-havana-logical-v1.jpg b/doc/training-guides/figures/openstack-arch-havana-logical-v1.jpg similarity index 100% rename from figures/openstack-arch-havana-logical-v1.jpg rename to doc/training-guides/figures/openstack-arch-havana-logical-v1.jpg diff --git a/figures/openstack-training-example-image.png b/doc/training-guides/figures/openstack-training-example-image.png similarity index 100% rename from figures/openstack-training-example-image.png rename to doc/training-guides/figures/openstack-training-example-image.png diff --git a/figures/openstack-training-remote-content-not-available.png b/doc/training-guides/figures/openstack-training-remote-content-not-available.png similarity index 100% rename from figures/openstack-training-remote-content-not-available.png rename to doc/training-guides/figures/openstack-training-remote-content-not-available.png diff --git a/lab000-important-terms.xml b/doc/training-guides/lab000-important-terms.xml similarity index 100% rename from lab000-important-terms.xml rename to doc/training-guides/lab000-important-terms.xml diff --git a/lab000-virtualbox-basics.xml b/doc/training-guides/lab000-virtualbox-basics.xml similarity index 100% rename from lab000-virtualbox-basics.xml rename to doc/training-guides/lab000-virtualbox-basics.xml diff --git a/lab001-control-node.xml b/doc/training-guides/lab001-control-node.xml similarity index 100% rename from lab001-control-node.xml rename to doc/training-guides/lab001-control-node.xml diff --git a/lab002-network-node.xml b/doc/training-guides/lab002-network-node.xml similarity index 100% rename from lab002-network-node.xml rename to doc/training-guides/lab002-network-node.xml diff --git a/lab003-compute-node.xml b/doc/training-guides/lab003-compute-node.xml similarity index 100% rename from lab003-compute-node.xml rename to doc/training-guides/lab003-compute-node.xml diff --git a/lab004-openstack-production.xml b/doc/training-guides/lab004-openstack-production.xml similarity index 100% rename from lab004-openstack-production.xml rename to doc/training-guides/lab004-openstack-production.xml diff --git a/locale/training-guides.pot b/doc/training-guides/locale/training-guides.pot similarity index 100% rename from locale/training-guides.pot rename to doc/training-guides/locale/training-guides.pot diff --git a/module001-ch001-intro-text.xml b/doc/training-guides/module001-ch001-intro-text.xml similarity index 100% rename from module001-ch001-intro-text.xml rename to doc/training-guides/module001-ch001-intro-text.xml diff --git a/module001-ch002-brief-overview.xml b/doc/training-guides/module001-ch002-brief-overview.xml similarity index 100% rename from module001-ch002-brief-overview.xml rename to doc/training-guides/module001-ch002-brief-overview.xml diff --git a/module001-ch003-core-projects.xml b/doc/training-guides/module001-ch003-core-projects.xml similarity index 100% rename from module001-ch003-core-projects.xml rename to doc/training-guides/module001-ch003-core-projects.xml diff --git a/module001-ch004-openstack-architecture.xml b/doc/training-guides/module001-ch004-openstack-architecture.xml similarity index 100% rename from module001-ch004-openstack-architecture.xml rename to doc/training-guides/module001-ch004-openstack-architecture.xml diff --git a/module001-ch005-vm-provisioning-walk-through.xml b/doc/training-guides/module001-ch005-vm-provisioning-walk-through.xml similarity index 100% rename from module001-ch005-vm-provisioning-walk-through.xml rename to doc/training-guides/module001-ch005-vm-provisioning-walk-through.xml diff --git a/module001-ch006-overview-horizon-cli.xml b/doc/training-guides/module001-ch006-overview-horizon-cli.xml similarity index 100% rename from module001-ch006-overview-horizon-cli.xml rename to doc/training-guides/module001-ch006-overview-horizon-cli.xml diff --git a/module001-ch007-keystone-arch.xml b/doc/training-guides/module001-ch007-keystone-arch.xml similarity index 100% rename from module001-ch007-keystone-arch.xml rename to doc/training-guides/module001-ch007-keystone-arch.xml diff --git a/module001-ch008-queues-messaging.xml b/doc/training-guides/module001-ch008-queues-messaging.xml similarity index 100% rename from module001-ch008-queues-messaging.xml rename to doc/training-guides/module001-ch008-queues-messaging.xml diff --git a/module001-ch009-vm-placement.xml b/doc/training-guides/module001-ch009-vm-placement.xml similarity index 100% rename from module001-ch009-vm-placement.xml rename to doc/training-guides/module001-ch009-vm-placement.xml diff --git a/module001-ch010-vm-provisioning-indepth.xml b/doc/training-guides/module001-ch010-vm-provisioning-indepth.xml similarity index 100% rename from module001-ch010-vm-provisioning-indepth.xml rename to doc/training-guides/module001-ch010-vm-provisioning-indepth.xml diff --git a/module001-ch011-block-storage.xml b/doc/training-guides/module001-ch011-block-storage.xml similarity index 100% rename from module001-ch011-block-storage.xml rename to doc/training-guides/module001-ch011-block-storage.xml diff --git a/module002-ch001-networking-in-openstack.xml b/doc/training-guides/module002-ch001-networking-in-openstack.xml similarity index 100% rename from module002-ch001-networking-in-openstack.xml rename to doc/training-guides/module002-ch001-networking-in-openstack.xml diff --git a/module002-ch002-openstack-networking-concepts.xml b/doc/training-guides/module002-ch002-openstack-networking-concepts.xml similarity index 100% rename from module002-ch002-openstack-networking-concepts.xml rename to doc/training-guides/module002-ch002-openstack-networking-concepts.xml diff --git a/module002-ch003-neutron-use-cases.xml b/doc/training-guides/module002-ch003-neutron-use-cases.xml similarity index 100% rename from module002-ch003-neutron-use-cases.xml rename to doc/training-guides/module002-ch003-neutron-use-cases.xml diff --git a/module002-ch004-security-in-neutron.xml b/doc/training-guides/module002-ch004-security-in-neutron.xml similarity index 100% rename from module002-ch004-security-in-neutron.xml rename to doc/training-guides/module002-ch004-security-in-neutron.xml diff --git a/module002-ch005-floating-ips.xml b/doc/training-guides/module002-ch005-floating-ips.xml similarity index 100% rename from module002-ch005-floating-ips.xml rename to doc/training-guides/module002-ch005-floating-ips.xml diff --git a/module003-ch006-more-concepts.xml b/doc/training-guides/module003-ch006-more-concepts.xml similarity index 100% rename from module003-ch006-more-concepts.xml rename to doc/training-guides/module003-ch006-more-concepts.xml diff --git a/operator-editing-code.xml b/doc/training-guides/operator-editing-code.xml similarity index 100% rename from operator-editing-code.xml rename to doc/training-guides/operator-editing-code.xml diff --git a/pom.xml b/doc/training-guides/pom.xml similarity index 100% rename from pom.xml rename to doc/training-guides/pom.xml diff --git a/sources/cinder/architecture.xml b/doc/training-guides/sources/cinder/architecture.xml similarity index 100% rename from sources/cinder/architecture.xml rename to doc/training-guides/sources/cinder/architecture.xml diff --git a/sources/cinder/development.environment.xml b/doc/training-guides/sources/cinder/development.environment.xml similarity index 100% rename from sources/cinder/development.environment.xml rename to doc/training-guides/sources/cinder/development.environment.xml diff --git a/sources/cinder/drivers.xml b/doc/training-guides/sources/cinder/drivers.xml similarity index 100% rename from sources/cinder/drivers.xml rename to doc/training-guides/sources/cinder/drivers.xml diff --git a/sources/cinder/threading.xml b/doc/training-guides/sources/cinder/threading.xml similarity index 100% rename from sources/cinder/threading.xml rename to doc/training-guides/sources/cinder/threading.xml diff --git a/sources/cinder/unit_tests.xml b/doc/training-guides/sources/cinder/unit_tests.xml similarity index 100% rename from sources/cinder/unit_tests.xml rename to doc/training-guides/sources/cinder/unit_tests.xml diff --git a/sources/convert_rst_xml.py b/doc/training-guides/sources/convert_rst_xml.py similarity index 100% rename from sources/convert_rst_xml.py rename to doc/training-guides/sources/convert_rst_xml.py diff --git a/st-training-guides.xml b/doc/training-guides/st-training-guides.xml similarity index 100% rename from st-training-guides.xml rename to doc/training-guides/st-training-guides.xml diff --git a/training-cluster-by-script.xml b/doc/training-guides/training-cluster-by-script.xml similarity index 100% rename from training-cluster-by-script.xml rename to doc/training-guides/training-cluster-by-script.xml diff --git a/training-labs/README.md b/doc/training-guides/training-labs/README.md similarity index 100% rename from training-labs/README.md rename to doc/training-guides/training-labs/README.md diff --git a/training-labs/Scripts/Cinder/Cinder.sh b/doc/training-guides/training-labs/Scripts/Cinder/Cinder.sh similarity index 100% rename from training-labs/Scripts/Cinder/Cinder.sh rename to doc/training-guides/training-labs/Scripts/Cinder/Cinder.sh diff --git a/training-labs/Scripts/Cinder/Templates/api-paste.ini b/doc/training-guides/training-labs/Scripts/Cinder/Templates/api-paste.ini similarity index 100% rename from training-labs/Scripts/Cinder/Templates/api-paste.ini rename to doc/training-guides/training-labs/Scripts/Cinder/Templates/api-paste.ini diff --git a/training-labs/Scripts/Cinder/Templates/cinder.conf b/doc/training-guides/training-labs/Scripts/Cinder/Templates/cinder.conf similarity index 100% rename from training-labs/Scripts/Cinder/Templates/cinder.conf rename to doc/training-guides/training-labs/Scripts/Cinder/Templates/cinder.conf diff --git a/training-labs/Scripts/Cinder/format_volumes.sh b/doc/training-guides/training-labs/Scripts/Cinder/format_volumes.sh similarity index 100% rename from training-labs/Scripts/Cinder/format_volumes.sh rename to doc/training-guides/training-labs/Scripts/Cinder/format_volumes.sh diff --git a/training-labs/Scripts/Glance/Glance.sh b/doc/training-guides/training-labs/Scripts/Glance/Glance.sh similarity index 100% rename from training-labs/Scripts/Glance/Glance.sh rename to doc/training-guides/training-labs/Scripts/Glance/Glance.sh diff --git a/training-labs/Scripts/Glance/Templates/glance-api-paste.ini b/doc/training-guides/training-labs/Scripts/Glance/Templates/glance-api-paste.ini similarity index 100% rename from training-labs/Scripts/Glance/Templates/glance-api-paste.ini rename to doc/training-guides/training-labs/Scripts/Glance/Templates/glance-api-paste.ini diff --git a/training-labs/Scripts/Glance/Templates/glance-api.conf b/doc/training-guides/training-labs/Scripts/Glance/Templates/glance-api.conf similarity index 100% rename from training-labs/Scripts/Glance/Templates/glance-api.conf rename to doc/training-guides/training-labs/Scripts/Glance/Templates/glance-api.conf diff --git a/training-labs/Scripts/Glance/Templates/glance-registry-paste.ini b/doc/training-guides/training-labs/Scripts/Glance/Templates/glance-registry-paste.ini similarity index 100% rename from training-labs/Scripts/Glance/Templates/glance-registry-paste.ini rename to doc/training-guides/training-labs/Scripts/Glance/Templates/glance-registry-paste.ini diff --git a/training-labs/Scripts/Glance/Templates/glance-registry.conf b/doc/training-guides/training-labs/Scripts/Glance/Templates/glance-registry.conf similarity index 100% rename from training-labs/Scripts/Glance/Templates/glance-registry.conf rename to doc/training-guides/training-labs/Scripts/Glance/Templates/glance-registry.conf diff --git a/training-labs/Scripts/Horizon/Horizon.sh b/doc/training-guides/training-labs/Scripts/Horizon/Horizon.sh similarity index 100% rename from training-labs/Scripts/Horizon/Horizon.sh rename to doc/training-guides/training-labs/Scripts/Horizon/Horizon.sh diff --git a/training-labs/Scripts/Keystone/Keystone.sh b/doc/training-guides/training-labs/Scripts/Keystone/Keystone.sh similarity index 100% rename from training-labs/Scripts/Keystone/Keystone.sh rename to doc/training-guides/training-labs/Scripts/Keystone/Keystone.sh diff --git a/training-labs/Scripts/Keystone/Scripts/Credentials.sh b/doc/training-guides/training-labs/Scripts/Keystone/Scripts/Credentials.sh similarity index 100% rename from training-labs/Scripts/Keystone/Scripts/Credentials.sh rename to doc/training-guides/training-labs/Scripts/Keystone/Scripts/Credentials.sh diff --git a/training-labs/Scripts/Keystone/Scripts/keystone_basic.sh b/doc/training-guides/training-labs/Scripts/Keystone/Scripts/keystone_basic.sh similarity index 100% rename from training-labs/Scripts/Keystone/Scripts/keystone_basic.sh rename to doc/training-guides/training-labs/Scripts/Keystone/Scripts/keystone_basic.sh diff --git a/training-labs/Scripts/Keystone/Scripts/keystone_endpoints_basic.sh b/doc/training-guides/training-labs/Scripts/Keystone/Scripts/keystone_endpoints_basic.sh similarity index 100% rename from training-labs/Scripts/Keystone/Scripts/keystone_endpoints_basic.sh rename to doc/training-guides/training-labs/Scripts/Keystone/Scripts/keystone_endpoints_basic.sh diff --git a/training-labs/Scripts/Keystone/Templates/Keystone.conf b/doc/training-guides/training-labs/Scripts/Keystone/Templates/Keystone.conf similarity index 100% rename from training-labs/Scripts/Keystone/Templates/Keystone.conf rename to doc/training-guides/training-labs/Scripts/Keystone/Templates/Keystone.conf diff --git a/training-labs/Scripts/Neutron/Neutron.sh b/doc/training-guides/training-labs/Scripts/Neutron/Neutron.sh similarity index 100% rename from training-labs/Scripts/Neutron/Neutron.sh rename to doc/training-guides/training-labs/Scripts/Neutron/Neutron.sh diff --git a/training-labs/Scripts/Neutron/Templates/SingleNode/api-paste.ini b/doc/training-guides/training-labs/Scripts/Neutron/Templates/SingleNode/api-paste.ini similarity index 100% rename from training-labs/Scripts/Neutron/Templates/SingleNode/api-paste.ini rename to doc/training-guides/training-labs/Scripts/Neutron/Templates/SingleNode/api-paste.ini diff --git a/training-labs/Scripts/Neutron/Templates/SingleNode/interfaces-single b/doc/training-guides/training-labs/Scripts/Neutron/Templates/SingleNode/interfaces-single similarity index 100% rename from training-labs/Scripts/Neutron/Templates/SingleNode/interfaces-single rename to doc/training-guides/training-labs/Scripts/Neutron/Templates/SingleNode/interfaces-single diff --git a/training-labs/Scripts/Neutron/Templates/SingleNode/metadata_agent.ini b/doc/training-guides/training-labs/Scripts/Neutron/Templates/SingleNode/metadata_agent.ini similarity index 100% rename from training-labs/Scripts/Neutron/Templates/SingleNode/metadata_agent.ini rename to doc/training-guides/training-labs/Scripts/Neutron/Templates/SingleNode/metadata_agent.ini diff --git a/training-labs/Scripts/Neutron/Templates/SingleNode/ovs_quantum_plugin.ini b/doc/training-guides/training-labs/Scripts/Neutron/Templates/SingleNode/ovs_quantum_plugin.ini similarity index 100% rename from training-labs/Scripts/Neutron/Templates/SingleNode/ovs_quantum_plugin.ini rename to doc/training-guides/training-labs/Scripts/Neutron/Templates/SingleNode/ovs_quantum_plugin.ini diff --git a/training-labs/Scripts/Neutron/Templates/SingleNode/quantum.conf b/doc/training-guides/training-labs/Scripts/Neutron/Templates/SingleNode/quantum.conf similarity index 100% rename from training-labs/Scripts/Neutron/Templates/SingleNode/quantum.conf rename to doc/training-guides/training-labs/Scripts/Neutron/Templates/SingleNode/quantum.conf diff --git a/training-labs/Scripts/Nova/Nova.sh b/doc/training-guides/training-labs/Scripts/Nova/Nova.sh similarity index 100% rename from training-labs/Scripts/Nova/Nova.sh rename to doc/training-guides/training-labs/Scripts/Nova/Nova.sh diff --git a/training-labs/Scripts/Nova/Templates/SingleNode/libvirt/libvirt-bin b/doc/training-guides/training-labs/Scripts/Nova/Templates/SingleNode/libvirt/libvirt-bin similarity index 100% rename from training-labs/Scripts/Nova/Templates/SingleNode/libvirt/libvirt-bin rename to doc/training-guides/training-labs/Scripts/Nova/Templates/SingleNode/libvirt/libvirt-bin diff --git a/training-labs/Scripts/Nova/Templates/SingleNode/libvirt/libvirt-bin.conf b/doc/training-guides/training-labs/Scripts/Nova/Templates/SingleNode/libvirt/libvirt-bin.conf similarity index 100% rename from training-labs/Scripts/Nova/Templates/SingleNode/libvirt/libvirt-bin.conf rename to doc/training-guides/training-labs/Scripts/Nova/Templates/SingleNode/libvirt/libvirt-bin.conf diff --git a/training-labs/Scripts/Nova/Templates/SingleNode/libvirt/libvirtd.conf b/doc/training-guides/training-labs/Scripts/Nova/Templates/SingleNode/libvirt/libvirtd.conf similarity index 100% rename from training-labs/Scripts/Nova/Templates/SingleNode/libvirt/libvirtd.conf rename to doc/training-guides/training-labs/Scripts/Nova/Templates/SingleNode/libvirt/libvirtd.conf diff --git a/training-labs/Scripts/Nova/Templates/SingleNode/libvirt/qemu.conf b/doc/training-guides/training-labs/Scripts/Nova/Templates/SingleNode/libvirt/qemu.conf similarity index 100% rename from training-labs/Scripts/Nova/Templates/SingleNode/libvirt/qemu.conf rename to doc/training-guides/training-labs/Scripts/Nova/Templates/SingleNode/libvirt/qemu.conf diff --git a/training-labs/Scripts/Nova/Templates/SingleNode/nova/api-paste.ini b/doc/training-guides/training-labs/Scripts/Nova/Templates/SingleNode/nova/api-paste.ini similarity index 100% rename from training-labs/Scripts/Nova/Templates/SingleNode/nova/api-paste.ini rename to doc/training-guides/training-labs/Scripts/Nova/Templates/SingleNode/nova/api-paste.ini diff --git a/training-labs/Scripts/Nova/Templates/SingleNode/nova/nova-compute.conf b/doc/training-guides/training-labs/Scripts/Nova/Templates/SingleNode/nova/nova-compute.conf similarity index 100% rename from training-labs/Scripts/Nova/Templates/SingleNode/nova/nova-compute.conf rename to doc/training-guides/training-labs/Scripts/Nova/Templates/SingleNode/nova/nova-compute.conf diff --git a/training-labs/Scripts/Nova/Templates/SingleNode/nova/nova.conf b/doc/training-guides/training-labs/Scripts/Nova/Templates/SingleNode/nova/nova.conf similarity index 100% rename from training-labs/Scripts/Nova/Templates/SingleNode/nova/nova.conf rename to doc/training-guides/training-labs/Scripts/Nova/Templates/SingleNode/nova/nova.conf diff --git a/training-labs/Scripts/PostInstall/PostInstall.sh b/doc/training-guides/training-labs/Scripts/PostInstall/PostInstall.sh similarity index 100% rename from training-labs/Scripts/PostInstall/PostInstall.sh rename to doc/training-guides/training-labs/Scripts/PostInstall/PostInstall.sh diff --git a/training-labs/Scripts/PreInstall/PreInstall.sh b/doc/training-guides/training-labs/Scripts/PreInstall/PreInstall.sh similarity index 100% rename from training-labs/Scripts/PreInstall/PreInstall.sh rename to doc/training-guides/training-labs/Scripts/PreInstall/PreInstall.sh diff --git a/training-labs/Scripts/PreInstall/Templates/interfaces-compute b/doc/training-guides/training-labs/Scripts/PreInstall/Templates/interfaces-compute similarity index 100% rename from training-labs/Scripts/PreInstall/Templates/interfaces-compute rename to doc/training-guides/training-labs/Scripts/PreInstall/Templates/interfaces-compute diff --git a/training-labs/Scripts/PreInstall/Templates/interfaces-control b/doc/training-guides/training-labs/Scripts/PreInstall/Templates/interfaces-control similarity index 100% rename from training-labs/Scripts/PreInstall/Templates/interfaces-control rename to doc/training-guides/training-labs/Scripts/PreInstall/Templates/interfaces-control diff --git a/training-labs/Scripts/PreInstall/Templates/interfaces-network b/doc/training-guides/training-labs/Scripts/PreInstall/Templates/interfaces-network similarity index 100% rename from training-labs/Scripts/PreInstall/Templates/interfaces-network rename to doc/training-guides/training-labs/Scripts/PreInstall/Templates/interfaces-network diff --git a/training-labs/Scripts/PreInstall/Templates/interfaces-single b/doc/training-guides/training-labs/Scripts/PreInstall/Templates/interfaces-single similarity index 100% rename from training-labs/Scripts/PreInstall/Templates/interfaces-single rename to doc/training-guides/training-labs/Scripts/PreInstall/Templates/interfaces-single diff --git a/training-labs/Scripts/PreInstall/Templates/vagrant/interfaces-compute b/doc/training-guides/training-labs/Scripts/PreInstall/Templates/vagrant/interfaces-compute similarity index 100% rename from training-labs/Scripts/PreInstall/Templates/vagrant/interfaces-compute rename to doc/training-guides/training-labs/Scripts/PreInstall/Templates/vagrant/interfaces-compute diff --git a/training-labs/Scripts/PreInstall/Templates/vagrant/interfaces-control b/doc/training-guides/training-labs/Scripts/PreInstall/Templates/vagrant/interfaces-control similarity index 100% rename from training-labs/Scripts/PreInstall/Templates/vagrant/interfaces-control rename to doc/training-guides/training-labs/Scripts/PreInstall/Templates/vagrant/interfaces-control diff --git a/training-labs/Scripts/PreInstall/Templates/vagrant/interfaces-network b/doc/training-guides/training-labs/Scripts/PreInstall/Templates/vagrant/interfaces-network similarity index 100% rename from training-labs/Scripts/PreInstall/Templates/vagrant/interfaces-network rename to doc/training-guides/training-labs/Scripts/PreInstall/Templates/vagrant/interfaces-network diff --git a/training-labs/Scripts/PreInstall/Templates/vagrant/interfaces-single b/doc/training-guides/training-labs/Scripts/PreInstall/Templates/vagrant/interfaces-single similarity index 100% rename from training-labs/Scripts/PreInstall/Templates/vagrant/interfaces-single rename to doc/training-guides/training-labs/Scripts/PreInstall/Templates/vagrant/interfaces-single diff --git a/training-labs/Scripts/test_scripts.sh b/doc/training-guides/training-labs/Scripts/test_scripts.sh similarity index 100% rename from training-labs/Scripts/test_scripts.sh rename to doc/training-guides/training-labs/Scripts/test_scripts.sh diff --git a/training-labs/Vagrantfile b/doc/training-guides/training-labs/Vagrantfile similarity index 100% rename from training-labs/Vagrantfile rename to doc/training-guides/training-labs/Vagrantfile diff --git a/training-labs/allinone.sh b/doc/training-guides/training-labs/allinone.sh similarity index 100% rename from training-labs/allinone.sh rename to doc/training-guides/training-labs/allinone.sh diff --git a/training-labs/compute.sh b/doc/training-guides/training-labs/compute.sh similarity index 100% rename from training-labs/compute.sh rename to doc/training-guides/training-labs/compute.sh diff --git a/training-labs/controller.sh b/doc/training-guides/training-labs/controller.sh similarity index 100% rename from training-labs/controller.sh rename to doc/training-guides/training-labs/controller.sh diff --git a/training-labs/install.sh b/doc/training-guides/training-labs/install.sh similarity index 100% rename from training-labs/install.sh rename to doc/training-guides/training-labs/install.sh diff --git a/training-labs/multinode.sh b/doc/training-guides/training-labs/multinode.sh similarity index 100% rename from training-labs/multinode.sh rename to doc/training-guides/training-labs/multinode.sh diff --git a/training-labs/network.sh b/doc/training-guides/training-labs/network.sh similarity index 100% rename from training-labs/network.sh rename to doc/training-guides/training-labs/network.sh diff --git a/training-labs/singlenode.sh b/doc/training-guides/training-labs/singlenode.sh similarity index 100% rename from training-labs/singlenode.sh rename to doc/training-guides/training-labs/singlenode.sh diff --git a/training-labs/training-guides-cluster-scripts.tar b/doc/training-guides/training-labs/training-guides-cluster-scripts.tar similarity index 100% rename from training-labs/training-guides-cluster-scripts.tar rename to doc/training-guides/training-labs/training-guides-cluster-scripts.tar diff --git a/user-story-includes-template.xml b/doc/training-guides/user-story-includes-template.xml similarity index 100% rename from user-story-includes-template.xml rename to doc/training-guides/user-story-includes-template.xml diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 00000000..1484cdf5 --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1 @@ +openstack-doc-tools>=0.13 diff --git a/tox.ini b/tox.ini new file mode 100644 index 00000000..db66a47e --- /dev/null +++ b/tox.ini @@ -0,0 +1,90 @@ +[tox] +minversion = 1.6 +envlist = checkniceness,checksyntax,checkdeletions,checkbuild +skipsdist = True + +[testenv] +setenv = + VIRTUAL_ENV={envdir} +deps = -r{toxinidir}/test-requirements.txt +whitelist_externals = + bash + cp + mkdir + rm + sed + +[testenv:venv] +commands = {posargs} + +[testenv:checkniceness] +commands = openstack-doc-test --check-niceness {posargs} + +[testenv:checksyntax] +commands = + openstack-doc-test --check-syntax {posargs} + # Check that .po and .pot files are valid: + bash -c "find doc -type f -regex '.*\.pot?' -print0|xargs -0 -n 1 msgfmt --check-format -o /dev/null" + +[testenv:checkdeletions] +commands = openstack-doc-test --check-deletions {posargs} + +[testenv:checkbuild] +commands = openstack-doc-test --check-build {posargs} + +[testenv:publishdocs] +# Prepare all documents (except www subdir) so that they can get +# published on docs.openstack.org with just copying publish-docs/* +# over. +commands = + # Create directory, it might not be here if openstack-doc-test does + # not publish anything. + mkdir publish-docs + # We only publish changed manuals. + openstack-doc-test --check-build --publish + # Now publish www as well, we cannot do this from + # openstack-doc-test. + bash -c "cp -a www/* publish-docs/" + +#[testenv:checklang] +# Generatedocbook needs xml2po which cannot be installed +# in the venv. Since it's installed in the system, let's +# use sitepackages. +#sitepackages=True +#whitelist_externals = bash +#commands = bash tools/test-languages.sh + +#[testenv:buildlang-install] +# Run as "tox -e buildlang-install -- $LANG" +# Generatedocbook needs xml2po which cannot be installed +# in the venv. Since it's installed in the system, let's +# use sitepackages. +#sitepackages=True +#whitelist_externals = bash +#commands = +# openstack-generate-docbook -l {posargs} -b common +# openstack-generate-docbook -l {posargs} -b glossary +# openstack-generate-docbook -l {posargs} -b install-guide +# # tox 1.7 does not parse the following line: +# # cp doc/pom.xml generated/{posargs}/pom.xml +# # Thus replaced by the next one: +# bash ./tools/copy_pom {posargs} +# openstack-doc-test --check-build --publish -l {posargs} --only-book install-guide + +#[testenv:buildlang-misc] +# Run as "tox -e buildlang-misc -- $LANG" +# Generatedocbook needs xml2po which cannot be installed +# in the venv. Since it's installed in the system, let's +# use sitepackages. +#sitepackages=True +#whitelist_externals = bash +#commands = +# openstack-generate-docbook -l {posargs} -b common +# openstack-generate-docbook -l {posargs} -b glossary +# openstack-generate-docbook -l {posargs} -b security-guide +# openstack-generate-docbook -l {posargs} -b high-availability-guide +# # tox 1.7 does not parse the following line: +# # cp doc/pom.xml generated/{posargs}/pom.xml +# # Thus replaced by the next one: +# bash ./tools/copy_pom {posargs} +# openstack-doc-test --check-build --publish -l {posargs} --only-book security-guide --only-book high-availability-guide