airship/docs

Drew Walters bc6b004dba Restructure Documentation

This change restructures the documentation into three categories that we
will expand on later:

  1. Try Airship
  2. Develop Airship
  3. Learn About Airship

Change-Id: I52286c3b1d87222a436be86b4ab748dba61d080c
Signed-off-by: Drew Walters <andrew.walters@att.com>

2020-03-02 16:04:01 +00:00

1.5 KiB

Raw Blame History

Airship Conventions

Airship components conform to a minimal set of conventions to provide for reasonable levels of consistency.

Language

While these documents are not an IETF RFC, RFC 2119 provides for useful language definitions. In this spirit:

'must', 'shall', 'will', and 'required' language indicates inflexible rules.
'should' and 'recommended' language is expected to be followed but reasonable exceptions may exist.
'may' and 'can' language is intended to be optional, but will provide a recommended approach if used.

Conventions and Standards

api-conventions code-conventions crd-conventions documentation-conventions service-logging-conventions