15 Commits

Author SHA1 Message Date
Duong Ha-Quang
1aeecf1045 Fix docs formatting error
Fix tox -e docs error when compiling docs.

Change-Id: I68857ff4a81c7814d4b14e1d2b8ee5c7310bce1e
2016-10-17 09:09:12 +07:00
Hironori Shiina
7b2a2ce298 Fix a few typos in documentation
This patch fixes a few typos in Contribution guide.

Change-Id: I00cc3fc956aea762d4e17a8a7daee05cfd304495
2016-09-30 21:58:38 +09:00
Christian Berendt
cd59e9207b Document that YAML data files should start with three dashes
Change-Id: I1ecf4d4198652ff5ad6b542b2e3b9cbf4afd20de
2016-09-21 20:07:47 +02:00
Christian Berendt
1908825f92 Document that new services have to be listed in the README file
TrivialFix

Change-Id: I53b7ab6253325b5f7b043afdd6a0dc2df306d3dd
2016-09-19 14:46:24 +02:00
Christian Berendt
ddbbd05be0 Document how to add logging for a service
TrivialFix

Change-Id: I2e912176174538fb1aded27e54c6a10acaf7d34b
2016-09-15 12:07:52 +00:00
Paul Bourke
36c0501cc6 Fix formatting in CONTRIBUTING.rst
Change-Id: I38a1fc5f476dca97952160eb2c2fbb25a19bcc64
2016-09-13 17:49:36 +01:00
Paul Bourke
8229baff74 Add guidelines on adding a new service
Add docs to provide more info and guidelines on how to add a new service
to Kolla.

There are a lot of patterns and practices that have evolved in Kolla so
it's good to formalise them to make it easier for both developers and
reviewers to ensure nothing has being missed.

Change-Id: I9ab858fdd0c756e2505fc0e3487bd8e026da5db1
2016-09-01 10:06:30 +01:00
Christian Berendt
5bb5899a6c Add a note about the sandbox environment to the CONTRIBUTING doc
TrivialFix

Change-Id: I6351da3c273c293cc97724f10cc0fea94a3f2fda
2016-08-16 17:42:21 +02:00
Kenny Johnston
856d0a866c Minor formatting change to CONTRIBUTING.rst
Removed numbered list formatting from single
item list.

Change-Id: Ifc9722e620eefc2580da921bc0c3084b9c25142c
2016-08-15 11:49:36 -05:00
Robin Naundorf
a7c41a8893 Fix inconsistencies in git url
Github is just a mirror of the OpenStack git-repo.
Changed from Github to OpenStack git url wherever possible.

Change-Id: I7941ef86967de4efe7f23ff9fb11ec86c793901e
2016-08-06 14:21:23 +02:00
Christian Berendt
c3d8262ec5 Add doc8 test and improve rst syntax
This will test all rst files inside the doc directory for style issues with
doc8 (an opinionated style checker for rst styles of documentation).

This will fix all syntax issues identified by doc8 and will improve
the syntax.

Change-Id: Id1b9563e07e77e306aef5a0767c98c27f87c5c0e
2016-08-04 15:09:10 +02:00
Asha Saravanamohan
a109c7473f Underline should match the title length in docs
According to the openstack contributer guide, the underlines
in an rst file should be of the same length as that of the
heading text to follow rst formatting conventions.
http://docs.openstack.org/contributor-guide/rst-conv/titles.html

Change-Id: I186abdfd87bc1e26fb822412b7335b1c42c25b25
Signed-off-by: Asha Saravanamohan <assarava@cisco.com>
2016-07-08 16:34:16 -07:00
Mauricio Lima
be2724a655 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
2016-05-27 08:10:43 -04:00
Swapnil Kulkarni (coolsvap)
d87b4f63a2 Structuring the documentation
Restructured the documenation to

1. Add reference at the top
2. Updated the title formatting
3. Updated the heading formatting
4. Updated the links formatting

Change-Id: Ie3786e92fee674da1fa39cf07f1bf0a3badd5b92
2016-05-16 23:55:35 +05:30
Mauricio Lima
6dfc1ef650 Add a CONTRIBUTING.rst for Kolla
Change-Id: I9910b4fba5ef11c26e687af3273e4fccaf5f235f
Closes-Bug: #1570017
2016-05-04 08:10:33 -04:00