docs/guides/onap-developer/how-to-use-docs/templates/sections/configuration.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 Configuration
   5 =============
   6
   7 ..
   8    * This section is used to describe the options a software component offers
   9       for configuration.
  10
  11    * Configuration is typically: provided for platform-component and sdk projects;
  12      and referenced in developer and user guides.
  13
  14
  15 Pre-requisites
  16 --------------
  17
  18 ..
  19   List here any dependencies and pre-requisites, e.g. component has to be
  20   deployed, necessary connections have been established, etc.
  21
  22
  23 Editing the configuration file
  24 ------------------------------
  25
  26 ..
  27   Describe the parameters and their values included in the config file.
  28
  29
  30 Configuration steps
  31 -------------------
  32
  33 ..
  34   Add the necessary steps to configure the component, including all options/
  35   alternatives.
  36   Provide examples (screenshots for GUI, commands for CLI) wherever possible.
  37
  38 #. Add the configuration.
  39
  40 Example command:
  41
  42 .. code-block:: bash
  43
  44    example command <parameter>
  45
  46 Example screenshot:
  47
  48 .. figure:: https://www.onap.org/wp-content/uploads/sites/20/2017/02/logo_onap_2017.png
  49   :alt: Example image
  50   :width: 50 %
  51
  52 #. Validate the configuration.
  53
  54 .. code-block:: bash
  55
  56    example command to validate the configuration
  57
  58 Output for successful execution:
  59
  60 .. code-block:: bash
  61
  62    Example output