openstack/openstack-manuals
Code Issues Proposed changes

improved contribution steps

Browse Source 
under-construction-notice.xml page was missing some important steps and the fix documentation link was incorrect.

bug/1212928

Change-Id: Ie2a6ddc423ec900d458ce98e80259c1d24b202f9
This commit is contained in:
Sean Roberts
2013-08-15 21:42:39 -07:00
parent 7137e4d4c6
commit 0570b793aa
1 changed files with 26 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -33,8 +33,8 @@
Backlog to yourself</para>
</listitem>
<listitem>
<para>Create a bp/training-manuals branch (e.g. git branch -b
bp/training-manuals)</para>
<para>Create a bp/training-manuals
branch<programlisting>$ git branch -b bp/training-manuals</programlisting></para>
</listitem>
<listitem>
<para>From the openstack-manuals repository, use the template <emphasis role="bold"
@@ -52,13 +52,32 @@
are not expecting.</para>
</listitem>
<listitem>
<para>Run maven locally to verify the build will run without errors (e.g. mvn clean
generate-sources)</para>
<para>Run maven locally to verify the build will run without errors
<programlisting>$ mvn clean generate-sources</programlisting></para>
</listitem>
<listitem>
<para>Follow the rest of the steps in <link
xlink:href="http://docs.openstack.org/trunk/openstack-training/content/operator-fix-documentation-bug.html"
>fix a documentation bug</link></para>
<para>Add your changes into git<programlisting>$ git add .</programlisting></para>
</listitem>
<listitem>
<para>Commit the changes with good syntax. After entering the commit command, VI syntax applies. Use "i" to insert and Esc to break out. ":wq" to write and quit.<programlisting>git commit -a
my very short summary
my more details go here. few sentences would be nice.
blueprint training-manuals</programlisting></para>
</listitem>
<listitem>
<para>Submit your patch for review<programlisting>$ git review</programlisting></para>
</listitem>
<listitem>
<para>Once last step. Go to the review page listed after your submitted your review
and add the training core team as reviewers; Sean Roberts and Colin McNamara.</para>
</listitem>
<listitem>
<para>More details here under <link
xlink:href="http://docs.openstack.org/trunk/openstack-training/content/fix-doc-bug.html"
>fix a documentation bug</link></para>
</listitem>
</orderedlist></para>
<para>