diff --git a/doc/source/contributor/doc_contribute_guide.rst b/doc/source/contributor/doc_contribute_guide.rst index 81413cdc9..c23252a4c 100644 --- a/doc/source/contributor/doc_contribute_guide.rst +++ b/doc/source/contributor/doc_contribute_guide.rst @@ -218,7 +218,7 @@ and implemented specs. ------------------ Document structure ------------------ - + .. begin-document-structure .. _index-rules: @@ -226,10 +226,10 @@ Document structure *********** Index rules *********** - + Each document consists of one main Sphinx index file, with two optional ones for each of Kubernetes and OpenStack content, if applicable. - + The index file contains one or more *toctrees*, which define the manifest and structure of topics to be included in the document. The index file must be at the root of the document's folder structure. If your document contains a mix of @@ -268,7 +268,7 @@ the two subindexes: ========= OpenStack ========= - + .. toctree:: openstack/index-1b466179efc3 @@ -280,62 +280,74 @@ random strings ``768a6e9aaeff`` and ``1b466179efc3`` were added by :command:`tox -e newfile` and will differ in your usage.) .. important:: - + Additional indexes, either at the root of the document or in subfolders, are not allowed. - + + The following images provide examples of correct and incorrect layouts. + + .. figure:: figures/index-structure-ok-2.png + + **Correct Kubernetes/OpenStack layout** + + + .. figure:: figures/index-structure-wrong.png + + **Incorrect Kubernetes/OpenStack layout** + + Use section headings in the index file to define document structure. For example: - -.. code-block:: - .. _contribute: - - ================== - Contributor Guides - ================== - - Welcome to the StarlingX community! We are glad you are here. - - If you are new to the project, take a moment to review the - `StarlingX wiki `_. - - --------------------------- - Contribute to documentation - --------------------------- - - .. toctree:: - :maxdepth: 1 - - doc_contribute_guide - api_contribute_guide - release_note_contribute_guide - blog_contribute_guide - website_contribute_guide - + .. code-block:: - - ------------------ - Contribute to code - ------------------ - - StarlingX follows the `OpenStack developer contribution guidelines - `_. Additional - StarlingX-specific resources are listed below. - - .. toctree:: - :maxdepth: 1 - - development_process - /developer_resources/code-submission-guide - /developer_resources/debug_issues - - -------------------- - Additional resources - -------------------- - - * `StarlingX wiki `_ - * :doc:`/developer_resources/index` + .. _contribute: + + ================== + Contributor Guides + ================== + + Welcome to the StarlingX community! We are glad you are here. + + If you are new to the project, take a moment to review the + `StarlingX wiki `_. + + --------------------------- + Contribute to documentation + --------------------------- + + .. toctree:: + :maxdepth: 1 + + doc_contribute_guide + api_contribute_guide + release_note_contribute_guide + blog_contribute_guide + website_contribute_guide + + + + ------------------ + Contribute to code + ------------------ + + StarlingX follows the `OpenStack developer contribution guidelines + `_. Additional + StarlingX-specific resources are listed below. + + .. toctree:: + :maxdepth: 1 + + development_process + /developer_resources/code-submission-guide + /developer_resources/debug_issues + + -------------------- + Additional resources + -------------------- + + * `StarlingX wiki `_ + * :doc:`/developer_resources/index` .. end-document-structure @@ -1651,7 +1663,7 @@ When using external references, be sure to prefix the URL with either When providing an example of a URL format, treat the example as code by either placing it in a ``.. code-block::`` or in double backticks, for example: - + .. code-block:: ``https:///`` diff --git a/doc/source/contributor/figures/index-structure-ok-1.png b/doc/source/contributor/figures/index-structure-ok-1.png new file mode 100644 index 000000000..4ac299de4 Binary files /dev/null and b/doc/source/contributor/figures/index-structure-ok-1.png differ diff --git a/doc/source/contributor/figures/index-structure-ok-2.png b/doc/source/contributor/figures/index-structure-ok-2.png new file mode 100644 index 000000000..2dce35c03 Binary files /dev/null and b/doc/source/contributor/figures/index-structure-ok-2.png differ diff --git a/doc/source/contributor/figures/index-structure-wrong.png b/doc/source/contributor/figures/index-structure-wrong.png new file mode 100644 index 000000000..639f478ef Binary files /dev/null and b/doc/source/contributor/figures/index-structure-wrong.png differ