a8660a7e53
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
1.5 KiB
1.5 KiB
Document Rendering
Document rendering involves extracting all raw revision documents from Deckhand's database, retrieving encrypted information from Barbican, and applying substitution, layering and replacement algorithms on the data.
The following algorithms are involved during the rendering process:
substitution
Substitution provides an "open" data sharing model in which any source document can be used to substitute data into any destination document.
layering
Layering provides a "restricted" data inheritance model intended to help reduce duplication in configuration.
replacement
Replacement builds on top of layering to provide yet another mechanism for reducing data duplication.