airship/deckhand
Code Issues Proposed changes

Fix documentation formatting

Browse Source 
A section of the rendered document does not indent the section properly.
This patch set fixes the rendering in RTD.

Trivial fix

Change-Id: I309cf291be863c143f3c390593b715982a3928fc
This commit is contained in:
Tin Lam 2017-12-02 12:38:09 -06:00
parent c26ad42e9f
commit 2af5c22b36
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/documents.rst
View File

@ -44,10 +44,12 @@ and ``data``.
* ``schema`` - Defines the name of the JSON schema to be used for validation. * ``schema`` - Defines the name of the JSON schema to be used for validation.
Must have the form: ``<namespace>/<kind>/<version>``, where the meaning of Must have the form: ``<namespace>/<kind>/<version>``, where the meaning of
each component is: each component is:
* ``namespace`` - Identifies the owner of this type of document. The
values `deckhand` and `metadata` are reserved for internal use. * ``namespace`` - Identifies the owner of this type of document. The values
``deckhand`` and ``metadata`` are reserved for internal use.
* ``kind`` - Identifies a type of configuration resource in the namespace. * ``kind`` - Identifies a type of configuration resource in the namespace.
* ``version`` - Describe the version of this resource, e.g. "v1". * ``version`` - Describe the version of this resource, e.g. ``v1``.
* ``metadata`` - Defines details that Deckhand will inspect and understand. * ``metadata`` - Defines details that Deckhand will inspect and understand.
There are multiple schemas for this section as discussed below. All the There are multiple schemas for this section as discussed below. All the
various types of metadata include a `name` field which must be unique for various types of metadata include a `name` field which must be unique for