..
      Copyright 2017 AT&T Intellectual Property.
      All Rights Reserved.

      Licensed under the Apache License, Version 2.0 (the "License"); you may
      not use this file except in compliance with the License. You may obtain
      a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
      License for the specific language governing permissions and limitations
      under the License.

.. _conventions:

Undercloud Platform Conventions
===============================
Undercloud Platform components conform to a minimal set of 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' lanugage is intended to be optional, but will provide a
   recommended approach if used.

Conventions and Standards
-------------------------

.. toctree::
   :maxdepth: 2

   alarming-conditions
   api-conventions
   rbac-conventions
   client-software
   code-conventions
   documentation-conventions
   service-logging-conventions
   security-conventions

.. _RFC 2119: https://www.ietf.org/rfc/rfc2119.txt