diff options
Diffstat (limited to 'docs/guides/onap-documentation/templates/sections/configuration.rst')
| -rw-r--r-- | docs/guides/onap-documentation/templates/sections/configuration.rst | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/docs/guides/onap-documentation/templates/sections/configuration.rst b/docs/guides/onap-documentation/templates/sections/configuration.rst new file mode 100644 index 000000000..6d1ec29ba --- /dev/null +++ b/docs/guides/onap-documentation/templates/sections/configuration.rst @@ -0,0 +1,62 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Configuration +============= + +.. + * This section is used to describe the options a software component offers + for configuration. + + * Configuration is typically: provided for platform-component and sdk projects; + and referenced in developer and user guides. + + +Pre-requisites +-------------- + +.. + List here any dependencies and pre-requisites, e.g. component has to be + deployed, necessary connections have been established, etc. + + +Editing the configuration file +------------------------------ + +.. + Describe the parameters and their values included in the config file. + + +Configuration steps +------------------- + +.. + Add the necessary steps to configure the component, including all options/ + alternatives. + Provide examples (screenshots for GUI, commands for CLI) wherever possible. + +#. Add the configuration. + +Example command: + +.. code-block:: bash + + example command <parameter> + +Example screenshot: + +.. figure:: https://www.onap.org/wp-content/uploads/sites/20/2017/02/logo_onap_2017.png + :alt: Example image + :width: 50 % + +#. Validate the configuration. + +.. code-block:: bash + + example command to validate the configuration + +Output for successful execution: + +.. code-block:: bash + + Example output |