From be2724a655185faae9abd57c8d07c12e48fd4aba Mon Sep 17 00:00:00 2001 From: Mauricio Lima Date: Fri, 27 May 2016 08:09:56 -0400 Subject: Update Documentation Applying RST formatting conventions [1],[2] and [3] [1] http://docs.openstack.org/contributor-guide/rst-conv/gen-guidelines.html [2] http://docs.openstack.org/contributor-guide/rst-conv/inline-markups.html [3] http://docs.openstack.org/contributor-guide/rst-conv/lists.html Change-Id: I38b77a45d30ca0542058675dd1e8aba790c68567 Partially-implements: blueprint documentation-rework --- doc/CONTRIBUTING.rst | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) (limited to 'doc/CONTRIBUTING.rst') diff --git a/doc/CONTRIBUTING.rst b/doc/CONTRIBUTING.rst index ae248028c..85c11271b 100644 --- a/doc/CONTRIBUTING.rst +++ b/doc/CONTRIBUTING.rst @@ -7,22 +7,22 @@ How To Contribute Basics ====== -* Our source code is hosted on `OpenStack GitHub`_, but pull requests submitted - through GitHub will be ignored. Bugs should be filed on launchpad_, - not GitHub. +#. Our source code is hosted on `OpenStack GitHub`_, but pull requests submitted + through GitHub will be ignored. Bugs should be filed on launchpad_, + not GitHub. -* Please follow OpenStack `Gerrit Workflow`_ to to contribute to Kolla. +#. Please follow OpenStack `Gerrit Workflow`_ to to contribute to Kolla. -* Note the branch you're proposing changes to. ``master`` is the current focus - of development. Kolla project has a strict policy of only allowing backports - in ``stable/branch``, unless when not applicable. A bug in a ``stable/branch`` - will first have to be fixed in ``master``. +#. Note the branch you're proposing changes to. ``master`` is the current focus + of development. Kolla project has a strict policy of only allowing backports + in ``stable/branch``, unless when not applicable. A bug in a ``stable/branch`` + will first have to be fixed in ``master``. -* Please file a launchpad_ blueprint for any significant code change and a bug - for any significant bug fix or add a TrivialFix tag for simple changes. - See how to reference a bug or a blueprint in the commit message here_ +#. Please file a launchpad_ blueprint for any significant code change and a bug + for any significant bug fix or add a TrivialFix tag for simple changes. + See how to reference a bug or a blueprint in the commit message here_ -* TrivialFix tags or bugs are not required for documentation changes. +#. TrivialFix tags or bugs are not required for documentation changes. .. _OpenStack GitHub: https://github.com/openstack/kolla .. _Gerrit Workflow: http://docs.openstack.org/infra/manual/developers.html#development-workflow @@ -32,6 +32,7 @@ Basics Development Environment ======================== -* Please follow our `quickstart`_ to deploy your environment and test your changes +#. Please follow our `quickstart`_ to deploy your environment and test your + changes. .. _quickstart: http://docs.openstack.org/developer/kolla/quickstart.html -- cgit v1.2.3