Illustrate index dependency rules
Add diagrams to show correct and incorrect index relationships in a Kubernetes/Openstack doc. Change-Id: I219cfad24f54d6ee4c7d4cafef36bd131693f7db Signed-off-by: Ron Stone <ronald.stone@windriver.com>
This commit is contained in:
parent
eb52adae9c
commit
5899336fc7
@ -284,10 +284,22 @@ random strings ``768a6e9aaeff`` and ``1b466179efc3`` were added by
|
||||
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::
|
||||
.. code-block::
|
||||
|
||||
.. _contribute:
|
||||
|
||||
|
BIN
doc/source/contributor/figures/index-structure-ok-1.png
Normal file
BIN
doc/source/contributor/figures/index-structure-ok-1.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 36 KiB |
BIN
doc/source/contributor/figures/index-structure-ok-2.png
Normal file
BIN
doc/source/contributor/figures/index-structure-ok-2.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 26 KiB |
BIN
doc/source/contributor/figures/index-structure-wrong.png
Normal file
BIN
doc/source/contributor/figures/index-structure-wrong.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 38 KiB |
Loading…
x
Reference in New Issue
Block a user