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

3.2 KiB

Raw Blame History

Deckhand Exceptions

deckhand.errors.BarbicanClientException

deckhand.errors.BarbicanServerException

deckhand.errors.DeepDiffException

deckhand.errors.DocumentNotFound

deckhand.errors.DuplicateDocumentExists

deckhand.errors.EncryptionSourceNotFound

deckhand.errors.InvalidDocumentFormat

deckhand.errors.IndeterminateDocumentParent

deckhand.errors.InvalidInputException

deckhand.errors.LayeringPolicyNotFound

deckhand.errors.MissingDocumentKey

deckhand.errors.MissingDocumentPattern

deckhand.errors.PolicyNotAuthorized

deckhand.errors.RevisionTagBadFormat

deckhand.errors.RevisionTagNotFound

deckhand.errors.RevisionNotFound

deckhand.errors.SingletonDocumentConflict

deckhand.errors.SubstitutionDependencyCycle

deckhand.errors.SubstitutionSourceDataNotFound

deckhand.errors.SubstitutionSourceNotFound

deckhand.errors.UnknownSubstitutionError

deckhand.errors.UnsupportedActionMethod

deckhand.errors.ValidationNotFound

3.2 KiB Raw Blame History

Deckhand Exceptions

3.2 KiB

Raw Blame History