aboutsummaryrefslogtreecommitdiff
path: root/doc/CONTRIBUTING.rst
AgeCommit message (Collapse)AuthorFilesLines
2017-10-11Rearrange existing documentation to fit the new standard layoutchenxing1-88/+0
For more detail, see the doc migration spec. http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html Partially-Implements: blueprint queens-doc-restructure Co-Authored-By: Kurt Taylor <kurt.r.taylor@gmail.com> Change-Id: Iab93bf023a13b953a31152b91d4fea0fa75bf2d0
2017-09-12Fix docs for maintainer label/instructionChristian Berendt1-1/+1
Ie87a1ddf31aefcd0b623fd2837d78de420e76898 introduced the maintainer label. Change-Id: I9ea982b34e9569a8c8d3cdc552a3000f8f8d2685
2017-07-21Update the documentation link for doc migrationchenxing1-1/+1
Change-Id: I93ecb6c27c2780e9cd86c8df065302b216fe7850
2017-06-12Use https links for documentationchenlx1-2/+2
Use https instead of http to ensure the safety. Change-Id: Iaf09b5b878e117d2333c30b8a769304a4a20f7ee
2017-02-05Remove include_header and include_footer in all DockerfilesJeffrey Zhang1-4/+0
include_header and include_footer parameter is already removed, remove them in all Dockerfiles. Add missing footer block. Change-Id: I90da03eb9f95a3827361d5f5ede65fde7d6be2b3
2017-01-26Remove all kolla-ansible related docsPaul Bourke1-98/+0
The goal of this patch is to reduce the docs hosted for this repo down to just the container images. Hyperlinks are provided to each of the available deployment mechanisms, currently kolla-ansible and kolla-kubernetes. This is to cut down confusion on which doc patches go where, as well as the massive duplication we currently have between kolla and kolla-ansible documentation. Further improvements could involve breaking out the 'Building Container Images' section into separate pages, e.g. quickstart, customisation, advanced, etc. Change-Id: Ia7959c71a241b9d7139ec50b34e36b24fbcf76e6
2016-11-15Update docs around TrivialFixPaul Bourke1-4/+4
Following a discussion on the mailing list[0] the community has agreed there is limited use around enforcing the TrivialFix tag for all commits that don't warrant a bug. Update the docs to reflect this. [0] http://lists.openstack.org/pipermail/openstack-dev/2016-November/106643.html Closes-Bug: 1641925 Change-Id: If9a73fc767ace681203e9dae8d0c291635060dc9
2016-11-06Add header blocks in CONTRIBUTING.rst guidecaowei1-0/+2
TrivialFix Change-Id: I5ef32d92b876b96d4bfc138a4b0408039c5a318e
2016-10-28change do_reconfigure.yml to reconfigure.yml in CONTRIBUTING.rstcaowei1-1/+1
TrivialFix Change-Id: I3b6a04753ad768afe96747c0185d73fb9913e0ec
2016-10-17Fix docs formatting errorDuong Ha-Quang1-20/+20
Fix tox -e docs error when compiling docs. Change-Id: I68857ff4a81c7814d4b14e1d2b8ee5c7310bce1e
2016-09-30Fix a few typos in documentationHironori Shiina1-4/+4
This patch fixes a few typos in Contribution guide. Change-Id: I00cc3fc956aea762d4e17a8a7daee05cfd304495
2016-09-21Document that YAML data files should start with three dashesChristian Berendt1-0/+4
Change-Id: I1ecf4d4198652ff5ad6b542b2e3b9cbf4afd20de
2016-09-19Document that new services have to be listed in the README fileChristian Berendt1-0/+8
TrivialFix Change-Id: I53b7ab6253325b5f7b043afdd6a0dc2df306d3dd
2016-09-15Document how to add logging for a serviceChristian Berendt1-6/+28
TrivialFix Change-Id: I2e912176174538fb1aded27e54c6a10acaf7d34b
2016-09-13Fix formatting in CONTRIBUTING.rstPaul Bourke1-14/+9
Change-Id: I38a1fc5f476dca97952160eb2c2fbb25a19bcc64
2016-09-01Add guidelines on adding a new servicePaul Bourke1-0/+117
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-08-16Add a note about the sandbox environment to the CONTRIBUTING docChristian Berendt1-1/+6
TrivialFix Change-Id: I6351da3c273c293cc97724f10cc0fea94a3f2fda
2016-08-15Minor formatting change to CONTRIBUTING.rstKenny Johnston1-2/+2
Removed numbered list formatting from single item list. Change-Id: Ifc9722e620eefc2580da921bc0c3084b9c25142c
2016-08-06Fix inconsistencies in git urlRobin Naundorf1-4/+3
Github is just a mirror of the OpenStack git-repo. Changed from Github to OpenStack git url wherever possible. Change-Id: I7941ef86967de4efe7f23ff9fb11ec86c793901e
2016-08-04Add doc8 test and improve rst syntaxChristian Berendt1-6/+6
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-07-08Underline should match the title length in docsAsha Saravanamohan1-1/+1
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-05-27Update DocumentationMauricio Lima1-13/+14
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-16Structuring the documentationSwapnil Kulkarni (coolsvap)1-2/+4
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-04Add a CONTRIBUTING.rst for KollaMauricio Lima1-0/+35
Change-Id: I9910b4fba5ef11c26e687af3273e4fccaf5f235f Closes-Bug: #1570017
generated by cgit v1.2.3 (git 2.39.1) at 2026-11-05 21:04:27 +0000