openstack/openstack-helm
Code Issues Proposed changes
8f38a1c45f
openstack-helm/doc/source/index.rst

23 lines
339 B
ReStructuredText
Raw Normal View History

Reduce doc max depth Current setting the maxdepth of 3 causes all the sub-headings (e.g. sub-titles under specs) to be displayed, needless expanding the table of content making the doc hard to read. This patch set reduces the maxdepth to 2 to reduce the noise in the OpenStack-Helm documentation. Also, this patch set touches up on RST structure and capitalization changes in the document. Change-Id: I7b8845f42180eafe08ed68a6c5a1e82ea49927be Signed-off-by: Tin Lam <tin@irrational.io>
2018-01-09 18:02:08 -06:00
Welcome to OpenStack-Helm's documentation!
==========================================
Beggining of docs conversion to OpenStack format This commit introduces initial infrastructure for building documentation using the OpenStack's sphinx extension and tox. To demonstrate that README.md is rewritten into README.rst and should appear in documentation built by `tox -e docs`. Partial-Implements: blueprint docs-to-rst Change-Id: I08ebad1c572e248a8f474e785d3bf7a19dbc4340
2017-04-27 11:01:26 +02:00
Contents:
.. toctree::
Reduce doc max depth Current setting the maxdepth of 3 causes all the sub-headings (e.g. sub-titles under specs) to be displayed, needless expanding the table of content making the doc hard to read. This patch set reduces the maxdepth to 2 to reduce the noise in the OpenStack-Helm documentation. Also, this patch set touches up on RST structure and capitalization changes in the document. Change-Id: I7b8845f42180eafe08ed68a6c5a1e82ea49927be Signed-off-by: Tin Lam <tin@irrational.io>
2018-01-09 18:02:08 -06:00
:maxdepth: 2
Beggining of docs conversion to OpenStack format This commit introduces initial infrastructure for building documentation using the OpenStack's sphinx extension and tox. To demonstrate that README.md is rewritten into README.rst and should appear in documentation built by `tox -e docs`. Partial-Implements: blueprint docs-to-rst Change-Id: I08ebad1c572e248a8f474e785d3bf7a19dbc4340
2017-04-27 11:01:26 +02:00
Add Project Specific Contributor and PTL Docs This patch amends contributor guidelines for the Ussuri goals. Change-Id: I9207d02a386e1250963b378bd9fd2188d78a613e Task: 38545 Story: 2007236
2020-04-24 15:26:51 +02:00
contributor/contributing
Add specs directory to OpenStack-Helm Adds the specs/ directory to openstack-helm for housing future specifications for the project. It also includes an appropriate README with directions for drafting specs, links to the openstack resources for bp+spec lifecycle, and a template for use in drafting specifications Change-Id: Ice23447b358b520a8b4fb703fc836e8f09fa34d1
2017-07-11 12:25:14 -05:00
devref/index
Add docs detailing testing and gating requirements Adds basic expectations and explanations of openstack-helms testing and gating approaches. This will continue to be expanded upon but serves to provide a base on which to build Change-Id: I689446b7124c4e11a92c73ef04e95d1840c6dc0a
2017-06-29 10:26:01 -05:00
gates
Add specs directory to OpenStack-Helm Adds the specs/ directory to openstack-helm for housing future specifications for the project. It also includes an appropriate README with directions for drafting specs, links to the openstack resources for bp+spec lifecycle, and a template for use in drafting specifications Change-Id: Ice23447b358b520a8b4fb703fc836e8f09fa34d1
2017-07-11 12:25:14 -05:00
install/index
readme
specs/index
Docs: Update ceph documentation - Adding section for Ceph troubleshoot - Rearrange Testing section to include Ceph Co-Authored-By: portdirect <pete@port.direct> Change-Id: Ib04e9b59fea2557cf6cad177dfcc76390c161e06 Signed-off-by: Pete Birley <pete@port.direct>
2018-05-04 11:36:39 -07:00
testing/index
Add specs directory to OpenStack-Helm Adds the specs/ directory to openstack-helm for housing future specifications for the project. It also includes an appropriate README with directions for drafting specs, links to the openstack resources for bp+spec lifecycle, and a template for use in drafting specifications Change-Id: Ice23447b358b520a8b4fb703fc836e8f09fa34d1
2017-07-11 12:25:14 -05:00
troubleshooting/index
Beggining of docs conversion to OpenStack format This commit introduces initial infrastructure for building documentation using the OpenStack's sphinx extension and tox. To demonstrate that README.md is rewritten into README.rst and should appear in documentation built by `tox -e docs`. Partial-Implements: blueprint docs-to-rst Change-Id: I08ebad1c572e248a8f474e785d3bf7a19dbc4340
2017-04-27 11:01:26 +02:00
Reduce doc max depth Current setting the maxdepth of 3 causes all the sub-headings (e.g. sub-titles under specs) to be displayed, needless expanding the table of content making the doc hard to read. This patch set reduces the maxdepth to 2 to reduce the noise in the OpenStack-Helm documentation. Also, this patch set touches up on RST structure and capitalization changes in the document. Change-Id: I7b8845f42180eafe08ed68a6c5a1e82ea49927be Signed-off-by: Tin Lam <tin@irrational.io>
2018-01-09 18:02:08 -06:00
Indices and Tables
Beggining of docs conversion to OpenStack format This commit introduces initial infrastructure for building documentation using the OpenStack's sphinx extension and tox. To demonstrate that README.md is rewritten into README.rst and should appear in documentation built by `tox -e docs`. Partial-Implements: blueprint docs-to-rst Change-Id: I08ebad1c572e248a8f474e785d3bf7a19dbc4340
2017-04-27 11:01:26 +02:00
==================
* :ref:`genindex`
* :ref:`search`
Copy Permalink