Documentation Guidelines

This documentation follows some guidelines. For example, keywords used in this documentation indicate requirement levels.

Documentation Structure

Each 'service' provided by NebularStack is indexed in this documentation's navigation. API documentation for each '*service' can be found as the last item in its sub-navigation.

Keyword Definitions

Our documentation keywords usage is inspired and built based on IETF RFC2119 for keyword definitions.

In many of our documents, several words signify the requirements for API parameters, pre-configured resources and other dependencies. These words are often capitalised.

  1. MUST This word, or the terms "REQUIRED" or "SHALL", mean that the definition is an absolute requirement of the specification.

  2. MUST NOT This phrase, or the phrase "SHALL NOT", means that the definition is an absolute prohibition of the specification.

  3. SHOULD This word, or the adjective "RECOMMENDED", means that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.

  4. SHOULD NOT This phrase, or the phrase "NOT RECOMMENDED" means that there may exist valid reasons in particular circumstances when the particular behaviour is acceptable or even useful, but the full implications should be understood, and the case should be carefully weighed before implementing any behaviour described with this label.

  5. MAY This word, or the adjective "OPTIONAL", means that an item is truly optional.