openstack/openstack-manuals
Code Issues Proposed changes

structure updates

Browse Source 
structure updates along with improved includes template file

blueprint training-manuals

Change-Id: I022722254105e5ec2008927947e04f95a7f22a26
This commit is contained in:
Sean Roberts
2013-08-09 12:42:46 -07:00
parent 58d21d5cce
commit 7fa12aa4bd
20 changed files with 565 additions and 466 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
doc/src/docbkx/openstack-training/bk001-ch001-associate-what-does-this-book-intend-to-teach.xml
View File

@@ -3,14 +3,57 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="bk001-ch001-associate-what-does-this-book-intend-to-teach">
<title>Associate What Does This Book Intend to Teach</title>
<section xml:id="associate-what-does-this-book-intend-to-teach">
<title>Associate section one</title>
<para>
<orderedlist>
<listitem>
<para/>
</listitem>
</orderedlist>
</para>
</section>
</chapter>
<para>
<orderedlist>
<listitem>
<para>training would take 1 month self paced, (2) 2 week periods with a user group meeting,
or 16 hours instructor led. Some time set aside for distro specific training.</para>
</listitem>
<listitem>
<para>basic knowledge of core OpenStack components (Compute, Block, Network,
Dashboard)</para>
</listitem>
<listitem>
<para>create an instance</para>
</listitem>
<listitem>
<para>understand conf and log files</para>
</listitem>
<listitem>
<para>understand basics of APIs and framework architecture</para>
</listitem>
<listitem>
<para>understand shared components</para>
</listitem>
<listitem>
<para>work off a single node openstack implementation</para>
</listitem>
<listitem>
<para>get on IRC, mailing lists</para>
</listitem>
<listitem>
<para>able to deploy applications to OpenStack clouds</para>
</listitem>
<listitem>
<para>able to leverage basic functions including pools IPs and multiple disks</para>
</listitem>
<listitem>
<para>able to deploy multi-tier applications to OpenStack clouds</para>
</listitem>
<listitem>
<para>advanced knowledge of OpenStack components including new and incubated
projects</para>
</listitem>
<listitem>
<para>able to create complicated network topologies</para>
</listitem>
<listitem>
<para>able to leverage advanced application topologies</para>
</listitem>
<listitem>
<para>able to operate and manage projects and elements via Horizon, and some
CLI</para>
</listitem>
</orderedlist>
</para>
</chapter>

3
doc/src/docbkx/openstack-training/bk001-ch002-associate-getting-started.xml
View File

@@ -3,8 +3,6 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="bk002-ch001-associate-getting-started">
<title>Associate Getting Started</title>
<section xml:id="associate-section-one">
<title>Associate section one</title>
<para>
<orderedlist>
<listitem>
@@ -12,5 +10,4 @@
</listitem>
</orderedlist>
</para>
</section>
</chapter>

78
doc/src/docbkx/openstack-training/bk001-ch003-associate-general.xml
View File

@@ -5,81 +5,5 @@
version="5.0"
xml:id="bk001-ch003-associate-general">
<title>Associate General</title>
<!-- chapter
<xi:include href="../basic-install/src/basic-install_intro.xml"</xi:include> -->
<para> Credit for basic install guide authors here</para>
<!-- chapter
<xi:include href="../basic-install/src/basic-install_architecture.xml"></xi:include> -->
<xi:include href="../basic-install/src/basic-install_requirements.xml"><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals. </link></para></xi:include>
<xi:include href="../basic-install/src/basic-install_controller-intro.xml"><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals. </link></para></xi:include>
<section xml:id="basic-install_controller-common-controller-os"><title>Basic Install Controller controller-os</title>
<section xml:id="basic-install_controller-common-controller-os-lead-in">
<title>lead in</title>
<para>Lead in to basic install controller OS section</para>
</section>
<xi:include href="../basic-install/src/basic-install_controller-common.xml" xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'controller-os'])">
<xi:fallback/></xi:include>
<section xml:id="submit-bug-controller-os"><title>submit a bug</title><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals. </link></para>
</section>
</section>
<xi:include href="../basic-install/src/basic-install_controller-common.xml" xpointer="element(controller-mysql)"><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals. </link></para></xi:include>
<xi:include href="../basic-install/src/basic-install_controller-common.xml" xpointer="element(controller-rabbitmq)"><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals. </link></para></xi:include>
<xi:include href="../basic-install/src/basic-install_controller-glance.xml"><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals. </link></para></xi:include>
<xi:include href="../basic-install/src/basic-install_controller-nova.xml"><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals. </link></para></xi:include>
<xi:include href="../basic-install/src/basic-install_controller-cinder.xml"><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals. </link></para></xi:include>
<xi:include href="../basic-install/src/basic-install_controller-neutron.xml"><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals. </link></para></xi:include>
<xi:include href="../basic-install/src/basic-install_controller-dashboard.xml"><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals. </link></para></xi:include>
<xi:include href="../basic-install/src/basic-install_network-intro.xml"><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals. </link></para></xi:include>
<xi:include href="../basic-install/src/basic-install_network-common.xml" xpointer="element(network-os)"><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals. </link></para></xi:include>
<xi:include href="../basic-install/src/basic-install_network-services.xml" xpointer="element(network-ovs)"><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals. </link></para></xi:include>
<xi:include href="../basic-install/src/basic-install_network-services.xml" xpointer="element(network-neutron)"><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals. </link></para></xi:include>
<xi:include href="../basic-install/src/basic-install_network-operating.xml" xpointer="element(create-networking)"><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals. </link></para></xi:include>
<xi:include href="../basic-install/src/basic-install_network-operating.xml" xpointer="element(configure-l3)"><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals. </link></para></xi:include>
<xi:include href="../basic-install/src/basic-install_compute-intro.xml"><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals. </link></para></xi:include>
<xi:include href="../basic-install/src/basic-install_compute-common.xml"><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals. </link></para></xi:include>
<xi:include href="../basic-install/src/basic-install_compute-nova.xml"><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals. </link></para></xi:include>
<xi:include href="../basic-install/src/basic-install_compute-neutron.xml"><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals. </link></para></xi:include>
<!-- preface
<xi:include href="../basic-install/src/basic-install_operate.xml"></xi:include>
<xi:include href="../basic-install/src/basic-install_conclusion.xml"></xi:include> -->
<para>User Stories are referenced here</para>
</chapter>

3
doc/src/docbkx/openstack-training/bk001-ch004-associate-assessment.xml
View File

@@ -3,8 +3,6 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="bk002-ch050-associate-assessment">
<title>Associate Assessment</title>
<section xml:id="associate-sections">
<title>Associate Sections</title>
<para>
<orderedlist>
<listitem>
@@ -12,5 +10,4 @@
</listitem>
</orderedlist>
</para>
</section>
</chapter>

63
doc/src/docbkx/openstack-training/bk002-ch001-operator-what-does-this-book-intend-to-teach.xml Normal file
View File

@@ -0,0 +1,63 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="bk002-ch001-operator-what-does-this-book-intend-to-teach">
<title>Operator What Does This Book Intend to Teach</title>
<para>
<orderedlist>
<listitem>
<para>training would take 2.5 months self paced, (5) 2 week periods with a user group
meeting, or 40 hours instructor led with 40 hours of self paced lab time. Some time set
aside for distro specific training.</para>
</listitem>
<listitem>
<para>able to fix bugs</para>
</listitem>
<listitem>
<para>able to commit documentation patches</para>
</listitem>
<listitem>
<para>deep understanding of nova and glance</para>
</listitem>
<listitem>
<para>deep understanding of one other core project;; swift, quantum, olso, or
cinder</para>
</listitem>
<listitem>
<para>trace workflow using zipkin</para>
</listitem>
<listitem>
<para>work off a three node openstack implementation, create a vagant/chef
configuration</para>
</listitem>
<listitem>
<para>based on <link
xlink:href="http://workstuff.tumblr.com/post/50911984233/some-tips-on-getting-started-with-vagrant-and-chef"
>
http://workstuff.tumblr.com/post/50911984233/some-tips-on-getting-started-with-vagrant-and-chef
</link></para>
</listitem>
<listitem>
<para>understanding of core components interaction through APIs</para>
</listitem>
<listitem>
<para>deep understanding of core conf and log files</para>
</listitem>
<listitem>
<para>puppet/chef understanding</para>
</listitem>
<listitem>
<para>git basics, create scenarios from <link xlink:href="http://git-scm.com/book/en/Git-Basics">http://git-scm.com/book/en/Git-Basics</link></para>
</listitem>
<listitem>
<para>reference Nova API reference<link xlink:href="http://docs.openstack.org/api/openstack-compute/2/content/">http://docs.openstack.org/api/openstack-compute/2/content/</link></para>
</listitem>
<listitem>
<para>Glance API reference<link xlink:href="http://docs.openstack.org/api/openstack-image-service/1.0/content/">http://docs.openstack.org/api/openstack-image-service/1.0/content/</link></para>
</listitem>
<listitem>
<para>5-10 scenarios to diagnose, hands on</para>
</listitem>
</orderedlist>
</para>
</chapter>

7
doc/src/docbkx/openstack-training/bk002-ch002-operations-getting-started.xml → doc/src/docbkx/openstack-training/bk002-ch002-operator-getting-started.xml
View File

@@ -1,10 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="bk003-ch002-operations-getting-started">
<title>Operations Getting Started</title>
<section xml:id="operations-getting-started">
<title>Operations Getting Started</title>
xml:id="bk003-ch002-operator-getting-started">
<title>Operator Getting Started</title>
<para>
<orderedlist>
<listitem>
@@ -12,5 +10,4 @@
</listitem>
</orderedlist>
</para>
</section>
</chapter>

296
doc/src/docbkx/openstack-training/bk002-ch003-operations-general.xml
View File

@@ -1,296 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="bk003-ch002-operations-fix-bug">
<title>Fix a Bug</title>
<section xml:id="getting-tools-and-accounts">
<title>Get Tools and Accounts</title>
<para>
<procedure>
<title>To get tools and accounts</title>
<step>
<para>Create a GitHub account at github.com.</para>
</step>
<step>
<para>Create your local repository directory</para>
<screen><prompt>$</prompt><userinput>mkdir /Users/yourusername/code/</userinput></screen>
</step>
<step>
<title>Install SourceTree</title>
<substeps>
<step>
<para>http://www.sourcetreeapp.com/download/</para>
</step>
<step>
<para>Ignore the Atlassian Bitbucket and Stack
setup</para>
</step>
<step>
<para>Add your GitHub username and password</para>
</step>
<step>
<para>Set your local</para>
</step>
</substeps>
</step>
<step>
<title>Install oXygen</title>
<substeps>
<step>
<para><link
xlink:href="http://www.oxygenxml.com/download_oxygenxml_editor.html"
>http://www.oxygenxml.com/download_oxygenxml_editor.html</link></para>
</step>
<step>
<para>Request the openstack registration code from
anne@openstack.org</para>
</step>
<step>
<para>Start oXygen, use registration code from anne
obtain the oxygen license</para>
</step>
<step>
<para>You will receive an email with the license data in
it. Copy and paste everything between and including
<code>------START-LICENSE-KEY------</code> and
<code>-------END-LICENSE-KEY-------</code></para>
</step>
</substeps>
</step>
<step>
<title>Install Maven</title>
<substeps>
<step>
<screen><prompt>$</prompt><userinput>mkdir /usr/local/apache-maven</userinput></screen>
</step>
<step>
<para>The latest stable binary from<link
xlink:href="http://maven.apache.org/download.cgi"
>http://maven.apache.org/download.cgi</link> into
/usr/local/apache-maven</para>
</step>
<step>
<para>create variables</para>
</step>
<step>
<screen><userinput>export M2_HOME=/usr/local/apache-maven/apache-maven-3.0.5
export M2=$M2_HOME/bin
export PATH=$M2:$PATH
export MAVEN_OPTS='-Xms256m -XX:MaxPermSize=1024m -Xmx1024m'</userinput></screen>
</step>
<step>
<para>verify maven is setup with</para>
<screen><prompt>$</prompt><userinput>mvn --install</userinput></screen>
</step>
</substeps>
</step>
<!-- the next five paragraphs were lifted from https://wiki.openstack.org/wiki/Documentation/HowTo#First-time_Contributors, we should figure out how to embed instead -->
<step>
<para>Create a Launchpad account: Visit
https://login.launchpad.net/+new_account After you create
this account, the follow-up page is slightly confusing. It
doesn't tell you that you are done. (It gives you the
opportunity to change your -password, but you do not have
to.)</para>
</step>
<step>
<para>Add at least one SSH key to your account profile. To
do this, follow the instructions
onhttps://help.launchpad.net/YourAccount/CreatingAnSSHKeyPair.</para>
</step>
<step>
<para>Sign the CLA: Every developer and contributor needs to
sign the Individual Contributor License agreement and join
the OpenStack Foundation. Visit
https://review.openstack.org/ and click the Sign In link
at the top-right corner of the page. Log in with your
Launchpad ID. You can preview the text of the Individual
CLA.</para>
</step>
<step>
<para>Create a Github account and add SSH keys to your
account profile (same one as used in Launchpad, they must
match). When you copy and paste the SSH key, include the
ssh-rsa algorithm and computer identifier. If this is your
first time setting up git and Github, be sure to run these
steps in a Terminal window:</para>
<screen><prompt>$</prompt><userinput>git config --global user.name "Firstname Lastname"
$ git config --global user.email "your_email@youremail.com" </userinput></screen>
</step>
<step>
<para>Install git-review. If pip is not already installed,
use "sudo easy_install pip" to install it on a Mac or
Ubuntu</para>
<screen><prompt>$</prompt><userinput>sudo pip install git-review</userinput></screen>
</step>
<step>
<para>Change to the directory</para>
<screen><prompt>$</prompt><userinput>cd /Users/yourusername/code</userinput></screen>
</step>
<step>
<para>Clone the openstack-manuals repository with</para><screen><prompt>$</prompt><userinput>git clone http://github.com/openstack/openstack-manuals.git</userinput></screen>
</step>
<step>
<para>Change directory to the pulled repository</para>
<screen><prompt>$</prompt><userinput>cd openstack-manuals</userinput></screen>
</step>
<step>
<para>Enter your Launchpad account information after testing
for ssh key setup with</para>
<screen><prompt>$</prompt><userinput>git review -s</userinput></screen>
</step>
</procedure>
</para>
</section>
<section xml:id="fix-doc-bug">
<title>Fix a Documentation Bug</title>
<para>
<procedure>
<title>To fix a documentation bug</title>
<step>
<para>Note: For this example, we are going to assume bug
1188522 and change 33713</para>
</step>
<step>
<para>Bring up<link
xlink:href="https://bugs.launchpad.net/openstack-manuals"
>https://bugs.launchpad.net/openstack-manuals</link></para>
</step>
<step>
<para>Select a bug that is unassigned and that you can fix.
Syntax errors are the best ones to start off with.</para>
</step>
<step>
<para>Using oXygen, open the
/Users/&lt;username>/code/openstack-manuals/doc/src/docbkx/openstack-compute-admin/bk_compute_adminguide.xml
master page for this example. It links together the rest
of the material. Find the page with the bug. Open the page
that is referenced in the bug description by selecting the
content in the author view. Verify you have the correct
page by visually inspecting the html page and the xml
page.</para>
</step>
<step>
<para>In the shell,</para>
<screen><prompt>$</prompt><userinput>cd /Users/&lt;username>/code/openstack-manuals/doc/src/docbkx/openstack-compute-admin/</userinput></screen>
</step>
<step>
<para>Verify that you are on master with</para>
<screen><prompt>$</prompt><userinput>git checkout master</userinput></screen>
</step>
<step>
<para>Create your working branch off master with</para>
<screen><prompt>$</prompt><userinput>git checkout -b bug/1188522</userinput></screen>
</step>
<step>
<para>Verify that you have the branch open through
SourceTree</para>
</step>
<step>
<para>Correct the bug through oXygen. Toggle back and forth
through the different views at the bottom of the
editor.</para>
</step>
<step>
<para>Once the bug is fixed, verify that the documentation
can be built without errors by running</para>
<screen><prompt>$</prompt><userinput>mvn clean generate-sources</userinput></screen>
</step>
<step>
<para>Add the changes</para>
<screen><prompt>$</prompt><userinput>git add .</userinput></screen>
</step>
<step>
<para>Commit the changes</para>
<screen><prompt>$</prompt><userinput>git commit -a -m " Removed reference to volume scheduler in the computer scheduler
config and admin pages, bug 1188522, author sean roberts"</userinput></screen>
</step>
<step>
<para>Submit the bug fix to Gerrit</para>
<screen><prompt>$</prompt><userinput>git review</userinput></screen>
</step>
<step>
<para>Track the Gerrit review process at<link
xlink:href="https://review.openstack.org/#/c/33713"
>https://review.openstack.org/#/c/33713</link>. Follow
and respond inline to the Code Review requests and
comments.</para>
</step>
<step>
<para>Your change will be tested, track the Jenkins testing
process at https://jenkins.openstack.org</para>
</step>
<step>
<para>If your change is rejected, complete the following steps:</para>
<substeps>
<step>
<para>Respond to the inline comments if any</para>
</step>
<step>
<para>Update the status to work in progress</para>
</step>
<step>
<para>Follow the recommended tweaks to the files</para>
</step>
<step>
<para>Rerun</para>
<screen><prompt>$</prompt><userinput>mvn clean generate-sources</userinput></screen>
</step>
<step>
<para>Commit the patch to the Gerrit change review</para>
<screen><prompt>$</prompt><userinput>git review -d 33713</userinput></screen>
</step>
<step>
<para>add your additional changes to the change log</para>
<screen><prompt>$</prompt><userinput>git commit -a --amend</userinput></screen>
</step>
<step>
<para>Final commit</para>
<screen><prompt>$</prompt><userinput>git review -v</userinput></screen>
</step>
<step>
<para>Update the Jenkins status to change completed</para>
</step>
</substeps>
</step>
<step>
<para>Follow the jenkins build progress at
https://jenkins.openstack.org/view/Openstack-manuals/.
Note if the build process fails, the online documentation
will not reflect your bug fix.</para>
</step>
</procedure>
</para>
</section>
<section xml:id="submit-doc-bug">
<title>Submit a Documentation Bug Fix</title>
<para>
<procedure>
<title>To submit a documentation bug fix</title>
<step>
<para>Bring up<link
xlink:href="https://bugs.launchpad.net/openstack-manuals/+filebug"
>https://bugs.launchpad.net/openstack-manuals/+filebug</link></para>
</step>
<step>
<para>Give your bug a descriptive name</para>
</step>
<step>
<para>verify if asked that it is not a duplicate</para>
</step>
<step>
<para>Add some more detail into the description field</para>
</step>
<step>
<para>Once submitted, select the assigned to pane and select
assign to me</para>
</step>
<step>
<para>Follow the instructions for fixing a bug in the Fix a
Documentation Bug section.</para>
</step>
</procedure>
</para>
</section>
</chapter>

9
doc/src/docbkx/openstack-training/bk002-ch003-operator-general.xml Normal file
View File

@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="bk003-ch002-operator-fix-bug">
<title>Operator General</title>
<para>User Stories are referenced here</para>
<xi:include href="operator-fix-bug.xml"/>
</chapter>

7
doc/src/docbkx/openstack-training/bk002-ch008-operations-assessment.xml → doc/src/docbkx/openstack-training/bk002-ch008-operator-assessment.xml
View File

@@ -1,10 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="bk003-ch050-operations-assessment">
<title>Operations Assessment</title>
<section xml:id="operations-assessment">
<title>Operations Assessment</title>
xml:id="bk003-ch050-operator-assessment">
<title>Operator Assessment</title>
<para>
<table rules="all"><caption>Trainee tasks</caption>
<thead>
@@ -170,5 +168,4 @@
</listitem>
</orderedlist>
</para>
</section>
</chapter>

37
doc/src/docbkx/openstack-training/bk003-ch001-developer-what-does-this-book-intend-to-teach.xml Normal file
View File

@@ -0,0 +1,37 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="bk003-ch001-developer-what-does-this-book-intend-to-teach">
<title>Developer What Does This Book Intend to Teach</title>
<para>
<orderedlist>
<listitem>
<para>build on concepts from Operator training</para>
</listitem>
<listitem>
<para>combine how to contribute and working with CI guides into a developers guide</para>
</listitem>
<listitem>
<para>training would take 2.5 months self paced, (5) 2 week periods with a user group
meeting, or 40 hours instructor led with 40 hours of self paced lab time. Some time
set aside for distro specific training.</para>
</listitem>
<listitem>
<para>include ideas from<link xlink:href="http://redmine.upstream-university.org/projects/slides/repository/revisions/master/show/training">http://redmine.upstream-university.org/projects/slides/repository/revisions/master/show/training</link>
<link xlink:href="http://www.slideshare.net/eyepv6/open-stack-summitsurvivingyourfirstcheckin">http://www.slideshare.net/eyepv6/open-stack-summitsurvivingyourfirstcheckin</link>
<link xlink:href="http://www.slideshare.net/delapsley1/opensack-quantum-devstack-tutorial">http://www.slideshare.net/delapsley1/opensack-quantum-devstack-tutorial</link>
<link xlink:href="http://www.slideshare.net/khinnu4u/developing-withdevstack">http://www.slideshare.net/khinnu4u/developing-withdevstack</link>
</para>
</listitem>
<listitem>
<para>deep understanding of APIs</para>
</listitem>
<listitem>
<para>commit python patches</para>
</listitem>
<listitem>
<para>karma greater than X</para>
</listitem>
</orderedlist>
</para>
</chapter>

3
doc/src/docbkx/openstack-training/bk003-ch002-developer-getting-started.xml
View File

@@ -3,8 +3,6 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ch-developer-getting-started">
<title>Developer Getting Started</title>
<section xml:id="developer-getting-started">
<title>Developer Getting Started</title>
<para>
<orderedlist>
<listitem>
@@ -12,5 +10,4 @@
</listitem>
</orderedlist>
</para>
</section>
</chapter>

3
doc/src/docbkx/openstack-training/bk003-ch010-developer-assessment.xml
View File

@@ -3,8 +3,6 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ch-developer-assessment">
<title>Developer Assessment</title>
<section xml:id="developer-assessment">
<title>Developer Assessment</title>
<para>
<orderedlist>
<listitem>
@@ -12,5 +10,4 @@
</listitem>
</orderedlist>
</para>
</section>
</chapter>

51
doc/src/docbkx/openstack-training/bk004-ch001-devops-what-does-this-book-intend-to-teach.xml Normal file
View File

@@ -0,0 +1,51 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="bk004-ch001-devops-what-does-this-book-intend-to-teach">
<title>DevOps What Does This Book Intend to Teach</title>
<para>
<orderedlist>
<listitem><para>Combination of Operator and Developer training</para>
</listitem>
<listitem>
<para>training would take 6 months or (12) 2 week periods with a user group meeting. 240
hours of self paced lab time.</para>
</listitem>
<listitem>
<para>Meant to be very hard to complete. Public contribution must be a considerable part
of the work completed.</para>
</listitem>
<listitem>
<para>code contribution</para>
</listitem>
<listitem>
<para>CI infrastructure time in</para>
</listitem>
<listitem>
<para>implementation builds</para>
</listitem>
<listitem>
<para>contributions to answer</para>
</listitem>
<listitem>
<para>speaking at user groups</para>
</listitem>
<listitem>
<para>summit session submissions should all count towards karma/contribution</para>
</listitem>
<listitem>
<para>use TripleO for build/ops environment. include <link xlink:href="https://github.com/tripleo/incubator/blob/master/devtest.md">https://github.com/tripleo/incubator/blob/master/devtest.md</link></para>
</listitem>
<listitem>
<para>karma greater than Y</para>
</listitem>
<listitem>
<para>Passing DevOps training would make the person desirable as an employee.</para>
</listitem>
<listitem>
<para>Passing DevOps training would make the person desirable as a core contributor to any
project</para>
</listitem>
</orderedlist>
</para>
</chapter>

3
doc/src/docbkx/openstack-training/bk004-ch002-devops-getting-started.xml
View File

@@ -3,8 +3,6 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ch-devops-getting-started">
<title>DevOps Getting Started</title>
<section xml:id="devops-getting-started">
<title>DevOps Getting Started</title>
<para>
<orderedlist>
<listitem>
@@ -12,5 +10,4 @@
</listitem>
</orderedlist>
</para>
</section>
</chapter>

3
doc/src/docbkx/openstack-training/bk004-ch010-devops-assessment.xml
View File

@@ -3,8 +3,6 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="ch-devops-assessment">
<title>DevOps Assessment</title>
<section xml:id="devops-assessment">
<title>DevOps Assessment</title>
<para>
<orderedlist>
<listitem>
@@ -12,5 +10,4 @@
</listitem>
</orderedlist>
</para>
</section>
</chapter>

34
doc/src/docbkx/openstack-training/bookstub-general-templatestub.xml
View File

@@ -1,34 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="bookstub-general-templatestub">
<title>Associate General Sub-Section</title>
<section xml:id="basic-install_requirements"><title>Basic Install Requirements</title>
<section xml:id="basic-install_requirements-lead-in">
<title>lead in</title>
<para>Lead in
Including a whole file</para>
</section>
<xi:include href="../basic-install/src/basic-install_requirements.xml" xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'basic-install_requirements'])">
<xi:fallback/></xi:include>
<section xml:id="submit-bug-basic-install_requirements"><title>submit a bug</title><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals.</link></para>
</section>
</section>
<section xml:id="basic-install_controller-common-controller-os"><title>Basic Install Controller controller-os</title>
<section xml:id="basic-install_controller-common-controller-os-lead-in">
<title>lead in</title>
<para>Lead in
Including a section of a file</para>
</section>
<xi:include href="../basic-install/src/basic-install_controller-common.xml" xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'controller-os'])">
<xi:fallback/></xi:include>
<section xml:id="submit-bug-controller-os"><title>submit a bug</title><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals.</link></para>
</section>
</section>
</chapter>

297
doc/src/docbkx/openstack-training/operator-fix-bug.xml Normal file
View File

@@ -0,0 +1,297 @@
<?xml version="1.0" encoding="utf-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="operator-fix-bug">
<title>Fix a Bug</title>
<section xml:id="getting-tools-and-accounts">
<title>Get Tools and Accounts</title>
<para>
<procedure>
<title>To get tools and accounts</title>
<step>
<para>Create a GitHub account at github.com.</para>
</step>
<step>
<para>Create your local repository directory</para>
<screen><prompt>$</prompt><userinput>mkdir /Users/yourusername/code/</userinput></screen>
</step>
<step>
<title>Install SourceTree</title>
<substeps>
<step>
<para>http://www.sourcetreeapp.com/download/</para>
</step>
<step>
<para>Ignore the Atlassian Bitbucket and Stack
setup</para>
</step>
<step>
<para>Add your GitHub username and password</para>
</step>
<step>
<para>Set your local</para>
</step>
</substeps>
</step>
<step>
<title>Install oXygen</title>
<substeps>
<step>
<para><link
xlink:href="http://www.oxygenxml.com/download_oxygenxml_editor.html"
>http://www.oxygenxml.com/download_oxygenxml_editor.html</link></para>
</step>
<step>
<para>Request the openstack registration code from
anne@openstack.org</para>
</step>
<step>
<para>Start oXygen, use registration code from anne
obtain the oxygen license</para>
</step>
<step>
<para>You will receive an email with the license data in
it. Copy and paste everything between and including
<code>------START-LICENSE-KEY------</code> and
<code>-------END-LICENSE-KEY-------</code></para>
</step>
</substeps>
</step>
<step>
<title>Install Maven</title>
<substeps>
<step>
<screen><prompt>$</prompt><userinput>mkdir /usr/local/apache-maven</userinput></screen>
</step>
<step>
<para>The latest stable binary from<link
xlink:href="http://maven.apache.org/download.cgi"
>http://maven.apache.org/download.cgi</link> into
/usr/local/apache-maven</para>
</step>
<step>
<para>create variables</para>
</step>
<step>
<screen><userinput>export M2_HOME=/usr/local/apache-maven/apache-maven-3.0.5
export M2=$M2_HOME/bin
export PATH=$M2:$PATH
export MAVEN_OPTS='-Xms256m -XX:MaxPermSize=1024m -Xmx1024m'</userinput></screen>
</step>
<step>
<para>verify maven is setup with</para>
<screen><prompt>$</prompt><userinput>mvn --install</userinput></screen>
</step>
</substeps>
</step>
<!-- the next five paragraphs were lifted from https://wiki.openstack.org/wiki/Documentation/HowTo#First-time_Contributors, we should figure out how to embed instead -->
<step>
<para>Create a Launchpad account: Visit
https://login.launchpad.net/+new_account After you create
this account, the follow-up page is slightly confusing. It
doesn't tell you that you are done. (It gives you the
opportunity to change your -password, but you do not have
to.)</para>
</step>
<step>
<para>Add at least one SSH key to your account profile. To
do this, follow the instructions
onhttps://help.launchpad.net/YourAccount/CreatingAnSSHKeyPair.</para>
</step>
<step>
<para>Sign the CLA: Every developer and contributor needs to
sign the Individual Contributor License agreement and join
the OpenStack Foundation. Visit
https://review.openstack.org/ and click the Sign In link
at the top-right corner of the page. Log in with your
Launchpad ID. You can preview the text of the Individual
CLA.</para>
</step>
<step>
<para>Create a Github account and add SSH keys to your
account profile (same one as used in Launchpad, they must
match). When you copy and paste the SSH key, include the
ssh-rsa algorithm and computer identifier. If this is your
first time setting up git and Github, be sure to run these
steps in a Terminal window:</para>
<screen><prompt>$</prompt><userinput>git config --global user.name "Firstname Lastname"
$ git config --global user.email "your_email@youremail.com" </userinput></screen>
</step>
<step>
<para>Install git-review. If pip is not already installed,
use "sudo easy_install pip" to install it on a Mac or
Ubuntu</para>
<screen><prompt>$</prompt><userinput>sudo pip install git-review</userinput></screen>
</step>
<step>
<para>Change to the directory</para>
<screen><prompt>$</prompt><userinput>cd /Users/yourusername/code</userinput></screen>
</step>
<step>
<para>Clone the openstack-manuals repository with</para><screen><prompt>$</prompt><userinput>git clone http://github.com/openstack/openstack-manuals.git</userinput></screen>
</step>
<step>
<para>Change directory to the pulled repository</para>
<screen><prompt>$</prompt><userinput>cd openstack-manuals</userinput></screen>
</step>
<step>
<para>Enter your Launchpad account information after testing
for ssh key setup with</para>
<screen><prompt>$</prompt><userinput>git review -s</userinput></screen>
</step>
</procedure>
</para>
</section>
<section xml:id="fix-doc-bug">
<title>Fix a Documentation Bug</title>
<para>
<procedure>
<title>To fix a documentation bug</title>
<step>
<para>Note: For this example, we are going to assume bug
1188522 and change 33713</para>
</step>
<step>
<para>Bring up<link
xlink:href="https://bugs.launchpad.net/openstack-manuals"
>https://bugs.launchpad.net/openstack-manuals</link></para>
</step>
<step>
<para>Select a bug that is unassigned and that you can fix.
Syntax errors are the best ones to start off with.</para>
</step>
<step>
<para>Using oXygen, open the
/Users/&lt;username>/code/openstack-manuals/doc/src/docbkx/openstack-compute-admin/bk_compute_adminguide.xml
master page for this example. It links together the rest
of the material. Find the page with the bug. Open the page
that is referenced in the bug description by selecting the
content in the author view. Verify you have the correct
page by visually inspecting the html page and the xml
page.</para>
</step>
<step>
<para>In the shell,</para>
<screen><prompt>$</prompt><userinput>cd /Users/&lt;username>/code/openstack-manuals/doc/src/docbkx/openstack-compute-admin/</userinput></screen>
</step>
<step>
<para>Verify that you are on master with</para>
<screen><prompt>$</prompt><userinput>git checkout master</userinput></screen>
</step>
<step>
<para>Create your working branch off master with</para>
<screen><prompt>$</prompt><userinput>git checkout -b bug/1188522</userinput></screen>
</step>
<step>
<para>Verify that you have the branch open through
SourceTree</para>
</step>
<step>
<para>Correct the bug through oXygen. Toggle back and forth
through the different views at the bottom of the
editor.</para>
</step>
<step>
<para>Once the bug is fixed, verify that the documentation
can be built without errors by running</para>
<screen><prompt>$</prompt><userinput>mvn clean generate-sources</userinput></screen>
</step>
<step>
<para>Add the changes</para>
<screen><prompt>$</prompt><userinput>git add .</userinput></screen>
</step>
<step>
<para>Commit the changes</para>
<screen><prompt>$</prompt><userinput>git commit -a -m " Removed reference to volume scheduler in the computer scheduler
config and admin pages, bug 1188522, author sean roberts"</userinput></screen>
</step>
<step>
<para>Submit the bug fix to Gerrit</para>
<screen><prompt>$</prompt><userinput>git review</userinput></screen>
</step>
<step>
<para>Track the Gerrit review process at<link
xlink:href="https://review.openstack.org/#/c/33713"
>https://review.openstack.org/#/c/33713</link>. Follow
and respond inline to the Code Review requests and
comments.</para>
</step>
<step>
<para>Your change will be tested, track the Jenkins testing
process at https://jenkins.openstack.org</para>
</step>
<step>
<para>If your change is rejected, complete the following steps:</para>
<substeps>
<step>
<para>Respond to the inline comments if any</para>
</step>
<step>
<para>Update the status to work in progress</para>
</step>
<step>
<para>Follow the recommended tweaks to the files</para>
</step>
<step>
<para>Rerun</para>
<screen><prompt>$</prompt><userinput>mvn clean generate-sources</userinput></screen>
</step>
<step>
<para>Commit the patch to the Gerrit change review</para>
<screen><prompt>$</prompt><userinput>git review -d 33713</userinput></screen>
</step>
<step>
<para>add your additional changes to the change log</para>
<screen><prompt>$</prompt><userinput>git commit -a --amend</userinput></screen>
</step>
<step>
<para>Final commit</para>
<screen><prompt>$</prompt><userinput>git review -v</userinput></screen>
</step>
<step>
<para>Update the Jenkins status to change completed</para>
</step>
</substeps>
</step>
<step>
<para>Follow the jenkins build progress at
https://jenkins.openstack.org/view/Openstack-manuals/.
Note if the build process fails, the online documentation
will not reflect your bug fix.</para>
</step>
</procedure>
</para>
</section>
<section xml:id="submit-doc-bug">
<title>Submit a Documentation Bug Fix</title>
<para>
<procedure>
<title>To submit a documentation bug fix</title>
<step>
<para>Bring up<link
xlink:href="https://bugs.launchpad.net/openstack-manuals/+filebug"
>https://bugs.launchpad.net/openstack-manuals/+filebug</link></para>
</step>
<step>
<para>Give your bug a descriptive name</para>
</step>
<step>
<para>verify if asked that it is not a duplicate</para>
</step>
<step>
<para>Add some more detail into the description field</para>
</step>
<step>
<para>Once submitted, select the assigned to pane and select
assign to me</para>
</step>
<step>
<para>Follow the instructions for fixing a bug in the Fix a
Documentation Bug section.</para>
</step>
</procedure>
</para>
</section>
</section>

19
doc/src/docbkx/openstack-training/st-training-guides.xml
View File

@@ -66,16 +66,6 @@
</itemizedlist>
</revdescription>
</revision>
<revision>
<date>2013-08-08</date>
<revdescription>
<itemizedlist spacing="compact">
<listitem>
<para>first publish publishing along with improved content targeting</para>
</listitem>
</itemizedlist>
</revdescription>
</revision>
</revhistory>
</info>
<xi:include href="under-contruction-notice.xml"/>
@@ -84,11 +74,14 @@
<xi:include href="bk001-ch002-associate-getting-started.xml"/>
<xi:include href="bk001-ch003-associate-general.xml"/>
<xi:include href="bk001-ch004-associate-assessment.xml"/>
<xi:include href="bk002-ch002-operations-getting-started.xml"/>
<xi:include href="bk002-ch003-operations-general.xml"/>
<xi:include href="bk002-ch008-operations-assessment.xml"/>
<xi:include href="bk002-ch001-operator-what-does-this-book-intend-to-teach.xml"/>
<xi:include href="bk002-ch002-operator-getting-started.xml"/>
<xi:include href="bk002-ch003-operator-general.xml"/>
<xi:include href="bk002-ch008-operator-assessment.xml"/>
<xi:include href="bk003-ch001-developer-what-does-this-book-intend-to-teach.xml"/>
<xi:include href="bk003-ch002-developer-getting-started.xml"/>
<xi:include href="bk003-ch010-developer-assessment.xml"/>
<xi:include href="bk004-ch001-devops-what-does-this-book-intend-to-teach.xml"/>
<xi:include href="bk004-ch002-devops-getting-started.xml"/>
<xi:include href="bk004-ch010-devops-assessment.xml"/>
</book>

11
doc/src/docbkx/openstack-training/under-contruction-notice.xml
View File

@@ -3,8 +3,6 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="under-construction">
<title>OpenStack Training Guides Are Under Construction</title>
<section xml:id="under-construction-section">
<title>What Under Construction Means</title>
<para>We need your help! This is a community driven project to reuse as much of the existing
documentation as possible. We cannot make this work without your help. There is an easy way to
contribute to this effort. Look at the end of end section and you will see the Submit a Bug
@@ -35,9 +33,6 @@
</listitem>
</orderedlist>
</para>
</section>
<section xml:id="how-to-contribute">
<title>How To Contribute</title>
<para>Three different levels of contribution:<orderedlist>
<listitem>
<para>Extended Education Team</para>
@@ -88,6 +83,8 @@
<para>Review patches and bugs</para>
<para>Take up Community Team member responsibilties as well time permitting</para>
</listitem>
</orderedlist></para>
</section>
</orderedlist>
</para>
<para>Find the userstory-includes-template.xml file in the /openstack-training/ directory for
syntax on how to create your user stories</para>
</chapter>

39
doc/src/docbkx/openstack-training/userstory-includes-template.xml Normal file
View File

@@ -0,0 +1,39 @@
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="userstory-includes-template">
<title>Including external content for user stories</title>
<para>Save your user story file as associate-my-user-story, operator-my-user-story, etc. For
example my user story that I assigned myself is operator bug fix so the file name would be
operator-bug-fix.xml. See the operator-bug-fix.xml file in the repository for more
details.</para>
<para>The include statements below are meant to help you tell and teach the user story. Include as much content as necessary. Use examples. Create diagrams through gdraw. Export as png. Reference as local file. Include URL to publically shared gdraw so anyone else can update.</para>
<section xml:id="foobar-section">
<title>Descriptive Section Title</title>
<section xml:id="foobar-lead-in">
<title>lead in</title>
<para>Including a whole file. Include as much description about what is being taught with here.</para>
</section>
<xi:include href="../basic-install/src/basic-install_requirements.xml" xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'basic-install_requirements'])">
<xi:fallback/></xi:include>
<section xml:id="submit-bug-foobar-section"><title>submit a bug</title><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals.</link></para>
</section>
</section>
<section xml:id="fubar-section">
<title>Descriptive Section Title</title>
<section xml:id="fubar-lead-in">
<title>lead in</title>
<para>Including a section of a file. Include as much description about what is being taught with here.</para>
</section>
<xi:include href="../basic-install/src/basic-install_controller-common.xml" xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id = 'controller-os'])">
<xi:fallback/></xi:include>
<section xml:id="submit-bug-fubar-section"><title>submit a bug</title><para><link xlink:href="https://blueprints.launchpad.net/openstack-manuals/+filebug">Submit a bug on
the section above. Short description for the bug summary. Paragraph for the description and
then tag with training-manuals.</link></para>
</section>
</section>
</chapter>