diff options
| author | Scott Moser <smoser@brickies.net> | 2016-11-10 16:42:43 -0500 |
|---|---|---|
| committer | Scott Moser <smoser@brickies.net> | 2016-11-10 16:48:58 -0500 |
| commit | 127f0f5076bf8e5c53dd538899199455ebc08fbc (patch) | |
| tree | b749345cefd3c003a8e7960af32d50ea98fa2de3 /HACKING.rst | |
| parent | 25c218e5659445ecf64febe03c08c6fd9ca016e6 (diff) | |
| download | vyos-cloud-init-127f0f5076bf8e5c53dd538899199455ebc08fbc.tar.gz vyos-cloud-init-127f0f5076bf8e5c53dd538899199455ebc08fbc.zip | |
doc: make the RST files consistently formated and other improvements.
The biggest things here are:
* move doc/sources/*/README.rst to doc/rtd/topics/datasources
This gives each datasource a page in the rtd docs, which make
it easier to read.
* consistently use the same header style throughout.
As suggested at
http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html
use:
# with overline, for parts
* with overline, for chapters
=, for sections
-, for subsections
^, for subsubsections
“, for paragraphs
Also, move and re-format vendor-data documentation to rtd.
Diffstat (limited to 'HACKING.rst')
| -rw-r--r-- | HACKING.rst | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/HACKING.rst b/HACKING.rst index 4072d0fd..caee7ac1 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -1,13 +1,13 @@ -===================== +********************* Hacking on cloud-init -===================== +********************* This document describes how to contribute changes to cloud-init. It assumes you have a `Launchpad`_ account, and refers to your launchpad user as ``LP_USER`` throughout. Do these things once --------------------- +==================== * To contribute, you must sign the Canonical `contributor license agreement`_ @@ -21,11 +21,12 @@ Do these things once There is more information on Launchpad as a git hosting site in `Launchpad git documentation`_. -* Create a new remote pointing to your personal Launchpad repository +* Create a new remote pointing to your personal Launchpad repository. + This is equivalent to 'fork' on github. - This is equivalent to 'fork' on github:: + .. code:: sh - git remote add LP_USER git+ssh://LP_USER@git.launchpad.net/~LP_USER/cloud-init + git remote add LP_USER ssh://LP_USER@git.launchpad.net/~LP_USER/cloud-init git push LP_USER master .. _repository: https://git.launchpad.net/cloud-init @@ -34,7 +35,7 @@ Do these things once .. _Launchpad git documentation: https://help.launchpad.net/Code/Git Do these things for each feature or bug ---------------------------------------- +======================================= * Create a new topic branch for your work:: |