diff --git a/operator-editing-code.xml b/operator-editing-code.xml
index 3adbcbf4..461ba25c 100644
--- a/operator-editing-code.xml
+++ b/operator-editing-code.xml
@@ -20,7 +20,7 @@
Create your local repository directory
- $mkdir /Users/yourusername/code/
+ $mkdir /Users/username/code/Install SourceTree
@@ -66,17 +66,19 @@
Create the apache-maven directory
- $sudo mkdir /usr/local/apache-maven
+ $sudo mkdir /usr/local/apache-maven
+
- Copy the latest stable binary fromCopy the latest stable binary from http://maven.apache.org/download.cgi into
- /usr/local/apache-maven
+ /usr/local/apache-maven.
Install maven with
- $ sudo /usr/local/apache-maven/XXXXX
+ $sudo /usr/local/apache-maven/XXXXX
+
Add the maven path
@@ -89,7 +91,7 @@
$ export MAVEN_OPTS='-Xms256m -XX:MaxPermSize=1024m -Xmx1024m'
- verify maven is setup with
+ Verify that maven is setup with$sudo mvn --install
@@ -137,30 +139,31 @@
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:
- $git config --global user.name "Firstname Lastname"
+ $git config --global user.name "Firstname Lastname"
$ git config --global user.email "your_email@youremail.com"
- Install git-review. If pip is not already installed, use "sudo easy_install pip" to install it on a Mac or
+ Install git-review. If pip is not already installed, use sudo easy_install pip to install it on a Mac or
Ubuntu
- $sudo pip install git-review
+ $sudo pip install git-reviewChange to the directory
- $cd /Users/yourusername/code
+ $cd /Users/username/code
- Clone the openstack-manuals repository with$git clone http://github.com/openstack/openstack-manuals.git
+ Clone the openstack-manuals repository with
+ $git clone http://github.com/openstack/openstack-manuals.gitChange directory to the pulled repository
- $cd openstack-manuals
+ $cd openstack-manualsEnter your Launchpad account information after testing
for ssh key setup with
- $git review -s
+ $git review -s
@@ -184,7 +187,9 @@ $ git config --global user.email "your_email@youremail.com"
Using oXygen, open the
- /Users/<username>/code/openstack-manuals/doc/admin-guide-cloud/bk-admin-guide-cloud.xml
+
+ /Users/username/code/openstack-manuals/doc/admin-guide-cloud/bk-admin-guide-cloud.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
@@ -194,15 +199,15 @@ $ git config --global user.email "your_email@youremail.com"
In the shell,
- $cd /Users/<username>/code/openstack-manuals/doc/admin-guide-cloud/
+ $cd /Users/username/code/openstack-manuals/doc/admin-guide-cloud/Verify that you are on master with
- $git checkout master
+ $git checkout masterCreate your working branch off master with
- $git checkout -b bug/1188522
+ $git checkout -b bug/1188522Verify that you have the branch open through
@@ -216,24 +221,25 @@ $ git config --global user.email "your_email@youremail.com"
Once the bug is fixed, verify that the documentation
can be built without errors by running
- $mvn clean generate-sources
+ $mvn clean generate-sources
- Verify that the HTML page reflects your changes properly. You can open the file from the command line by using the "open" command
- $open target/docbkx/webhelp/local/openstack-training/index.html
+ Verify that the HTML page reflects your changes
+ properly. You can open the file from the command line by
+ using the "open" command
+ $open target/docbkx/webhelp/local/openstack-training/index.htmlAdd the changes
- $git add .
+ $git add .Commit the changes
- $git commit -a -m "Removed reference to volume scheduler in the computer scheduler
- config and admin pages, bug 1188522"
+ $git commit -a -m "Removed reference to volume scheduler in the computer scheduler config and admin pages, bug 1188522"Submit the bug fix to Gerrit
- $git review
+ $git reviewTrack the Gerrit review process at
Your change will be tested, track the Jenkins testing
- process at https://jenkins.openstack.org
+ process at
+ https://jenkins.openstack.orgIf your change is rejected, complete the following steps:
@@ -257,22 +264,22 @@ $ git config --global user.email "your_email@youremail.com"
Checkout the patch from the Gerrit change review
- $git review -d 33713
+ $git review -d 33713Follow the recommended tweaks to the filesRerun
- $mvn clean generate-sources
+ $mvn clean generate-sources
- add your additional changes to the change log
- $git commit -a --amend
+ Add your additional changes to the change log
+ $git commit -a --amendFinal commit
- $git review
+ $git reviewUpdate the Jenkins status to change completed
@@ -281,7 +288,9 @@ $ git config --global user.email "your_email@youremail.com"
Follow the jenkins build progress at
- https://jenkins.openstack.org/view/Openstack-manuals/.
+
+ https://jenkins.openstack.org/view/Openstack-manuals/
+ .
Note if the build process fails, the online documentation
will not reflect your bug fix.
@@ -301,7 +310,7 @@ $ git config --global user.email "your_email@youremail.com" Give your bug a descriptive name
- verify if asked that it is not a duplicate
+ Verify if asked that it is not a duplicateAdd some more detail into the description field
@@ -327,15 +336,19 @@ $ git config --global user.email "your_email@youremail.com" $ git checkout -b bp/training-manuals
- From the openstack-manuals repository, use the template user-story-includes-template.xml as the starting point for your user
- story. bk001-ch003-associate-general.xml has at
- least one other included user story that you can use for additional help.
+ From the openstack-manuals repository, use
+ the template user-story-includes-template.xml as
+ the starting point for your user story. File
+ bk001-ch003-associate-general.xml
+ has at least one other included user story that
+ you can use for additional help.
+
- Include the user story xml file into the bk001-ch003-associate-general.xml file. Follow the syntax of the
- existing xi:include statements.
+ Include the user story xml file into the bk001-ch003-associate-general.xml file. Follow the syntax of the
+ existing xi:include statements.When your editing is completed. Double check Oxygen doesn't have any errors you
@@ -397,11 +410,11 @@ blueprint training-manualsOpen the file st-training-guides.xml with
- your XML editor. All the content starts with the set file st-training-guides.xml. The XML structure follows
- the hierarchy Set -> Book -> Chapter -> Section. The st-training-guides.xml file holds the set level. Notice the
- set file uses xi:include statements to include the books. We want to open
+ your XML editor. All the content starts with the set file st-training-guides.xml. The XML structure follows
+ the hierarchy Set -> Book -> Chapter -> Section. The st-training-guides.xml file holds the set level. Notice the
+ set file uses xi:include statements to include the books. We want to open
the associate book. Open the associate book and you will see the chapter
include statements. These are the chapters that make up the Associate
Training Guide book.
@@ -415,20 +428,19 @@ blueprint training-manuals
branch merge.
- Copy the user-story-includes-template.xml
- to associate-card-XXX.xml.
+ Copy the user-story-includes-template.xml
+ to associate-card-XXX.xml.
- Open the bk001-ch003-asssociate-general.xml file and add Open the bk001-ch003-asssociate-general.xml file and add <xi:include
- href="associate-card-XXX.xml">
+ href="associate-card-XXX.xml">.
Side by side, open associate-card-XXX.xml
- with your XML editor and open the ubuntu 12.04 install
- guide with your HTML browser.
+ with your XML editor and open the Ubuntu 12.04 Install
+ Guide with your HTML browser.
Find the HTML content to include. Find the XML file that matches the HTML.
@@ -437,8 +449,8 @@ blueprint training-manuals
section using xpath like <xi:include
href="../basic-install/src/basic-install_controller-common.xml"
xpointer="xmlns(db=http://docbook.org/ns/docbook) xpath(//*[@xml:id =
- 'controller-os'])"> . Review the user-story-includes-template.xml file for the whole
+ 'controller-os'])"> . Review the user-story-includes-template.xml file for the whole
syntax.
@@ -449,16 +461,18 @@ blueprint training-manuals
from.
- Verify the code is good by runnning mvn clean generate-sources and by
+ Verify the code is good by runnning mvn clean generate-sources
+ and by
reviewing the local HTML in file:///Users/(localUser)/code/openstack-manuals/doc/training-guide/target/docbkx/webhelp/local/training-guide/content/
+ >file:///Users/username/code/openstack-manuals/doc/training-guide/target/docbkx/webhelp/local/training-guide/content/.
+
- Merge the branch
+ Merge the branch.
- Move the card from Doing to Done
+ Move the card from Doing to Done.