Integreate HACKING into the rtd site.

HACKING

@@ -4,30 +4,45 @@ Hacking on cloud-init
 
 To get changes into cloud-init, the process to follow is:
 
- * If you have not already, be sure to sign the CCA:
+* If you have not already, be sure to sign the CCA:
-    - `Canonical Contributor Agreement`_
 
- * Get your changes into a local bzr branch. Initialize a repo, and checkout trunk (init repo is to share bzr info across multiple checkouts, its different than git):
+  - `Canonical Contributor Agreement`_
-    - ``bzr init-repo cloud-init``
-    - ``bzr branch lp:cloud-init trunk.dist``
-    - ``bzr branch trunk.dist my-topic-branch``
 
- * Commit your changes (note, you can make multiple commits, fixes, more commits.):
+* Get your changes into a local bzr branch.
-    - ``bzr commit``
+  Initialize a repo, and checkout trunk (init repo is to share bzr info across multiple checkouts, its different than git):
 
- * Check pylint and pep8 and test, and address any issues:
+  - ``bzr init-repo cloud-init``
-    - ``make test pylint pep8``
+  - ``bzr branch lp:cloud-init trunk.dist``
+  - ``bzr branch trunk.dist my-topic-branch``
 
- * Push to launchpad to a personal branch:
+* Commit your changes (note, you can make multiple commits, fixes, more commits.):
-    - ``bzr push lp:~<YOUR_USERNAME>/cloud-init/<BRANCH_NAME>``
 
- * Propose that for a merge into lp:cloud-init via web browser. Open the branch in `Launchpad`_, it will be at https://code.launchpad.net/<YOUR_USERNAME>/<PROJECT>/<BRANCH_NAME> (ie. https://code.launchpad.net/~smoser/cloud-init/mybranch):
+  - ``bzr commit``
-    - Click 'Propose for merging'
-    - Select 'lp:cloud-init' as the target branch
 
-Then, someone on cloud-init-dev (currently Scott Moser and Joshua Harlow) will review your changes and follow up in the merge request.
+* Check pylint and pep8 and test, and address any issues:
 
-Feel free to ping #cloud-init on freenode if you have any questions.
+  - ``make test pylint pep8``
+
+* Push to launchpad to a personal branch:
+
+  - ``bzr push lp:~<YOUR_USERNAME>/cloud-init/<BRANCH_NAME>``
+
+* Propose that for a merge into lp:cloud-init via web browser.
+
+  - Open the branch in `Launchpad`_
+
+    - It will typically be at ``https://code.launchpad.net/<YOUR_USERNAME>/<PROJECT>/<BRANCH_NAME>``
+    - ie. https://code.launchpad.net/~smoser/cloud-init/mybranch
+
+* Click 'Propose for merging'
+* Select 'lp:cloud-init' as the target branch
+
+Then, someone on cloud-init-dev (currently `Scott Moser`_ and `Joshua Harlow`_) will 
+review your changes and follow up in the merge request.
+
+Feel free to ping and/or join #cloud-init on freenode (irc) if you have any questions.
 
 .. _Launchpad: https://launchpad.net
 .. _Canonical Contributor Agreement: http://www.canonical.com/contributors
+.. _Scott Moser: https://launchpad.net/~smoser
+.. _Joshua Harlow: https://launchpad.net/~harlowja

doc/rtd/conf.py

@@ -42,7 +42,7 @@ master_doc = 'index'
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 version = version.version_string()
-# release = version
+release = version
 
 # Set the default Pygments syntax
 highlight_language = 'python'

doc/rtd/index.rst

@@ -24,6 +24,6 @@ Summary
    topics/examples
    topics/modules
    topics/moreinfo
-
+   topics/hacking
 
 .. _Cloud-init: https://launchpad.net/cloud-init

doc/rtd/topics/moreinfo.rst

@@ -3,7 +3,7 @@ More information
 =========
 
 Useful external references
-----------------
+-------------------------
 
 - `The beauty of cloudinit`_
 - `Introduction to cloud-init`_ (video)