deckhand

Commit Graph

Author	SHA1	Message	Date
Felipe Monteiro	1ac9abb555	docs: Elaborate on document layering in documentation This patchset elaborates on document layering in the documentation to provide much greater clarity into what layering is and its associated concepts, including: layer, layer order, layering policy, layering definition, document abstraction, parent selection, layering actions, etc. Change-Id: I584e67b7984fa4035cef481a116ae3b8a3eb2906	2018-10-10 19:06:38 +00:00
Felipe Monteiro	a8660a7e53	docs: Reorganize documentation structure This patch set reorganizes Deckhand's documentation structure for better organization into 3 distinct categories: * developer's guide * operator's guide * user's guide This means that the RTD navigation menu on the left-hand side will have fewer links (see list above) making navigation much easier. This is similar to how Armada organizes its documentation too. This patch set also updates README section with a better overview and trims some fat from it (remove testing documentation as it doesn't really belong there -- there is a dedicated page for that already). Finally, this patch set changes the exceptions page to render as a basic list of autoexception classes because the current tabularized view is not rendering correctly on RTD [0]. [0] https://airship-deckhand.readthedocs.io/en/latest/exceptions.html Change-Id: I162383bf8e3bbd5004603c979ac7b0d760a210c4	2018-09-26 20:29:02 -04:00

Author

SHA1

Message

Date

Felipe Monteiro

1ac9abb555

docs: Elaborate on document layering in documentation

This patchset elaborates on document layering in the documentation
to provide much greater clarity into what layering is and its
associated concepts, including: layer, layer order, layering policy,
layering definition, document abstraction, parent selection,
layering actions, etc.

Change-Id: I584e67b7984fa4035cef481a116ae3b8a3eb2906

2018-10-10 19:06:38 +00:00

Felipe Monteiro

a8660a7e53

docs: Reorganize documentation structure

This patch set reorganizes Deckhand's documentation structure
for better organization into 3 distinct categories:

* developer's guide
* operator's guide
* user's guide

This means that the RTD navigation menu on the left-hand side
will have fewer links (see list above) making navigation much
easier. This is similar to how Armada organizes its documentation
too.

This patch set also updates README section with a better
overview and trims some fat from it (remove testing
documentation as it doesn't really belong there -- there
is a dedicated page for that already).

Finally, this patch set changes the exceptions page to
render as a basic list of autoexception classes because
the current tabularized view is not rendering correctly
on RTD [0].

[0] https://airship-deckhand.readthedocs.io/en/latest/exceptions.html
Change-Id: I162383bf8e3bbd5004603c979ac7b0d760a210c4

2018-09-26 20:29:02 -04:00

2 Commits