diff options
Diffstat (limited to 'docs/guides/onap-documentation/templates/sections/administration.rst')
| -rw-r--r-- | docs/guides/onap-documentation/templates/sections/administration.rst | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/docs/guides/onap-documentation/templates/sections/administration.rst b/docs/guides/onap-documentation/templates/sections/administration.rst new file mode 100644 index 000000000..841a55291 --- /dev/null +++ b/docs/guides/onap-documentation/templates/sections/administration.rst @@ -0,0 +1,69 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2021 ONAP contributors, Nokia + +Administration +============== + +.. + * This section is used to describe a software component from the perspective of on-going + operation including regular processes and actions that are taken to configure and manage + the component. + * This section is typically: provided for platform-component or applications; and + referenced in user guides. + * This note must be removed after content has been added. + + +Procedure +--------- + +.. + Use this section for each procedure you want to include. + + +Purpose +~~~~~~~ + +.. + The purpose of the procedure, what is the intended outcome, possible + dependencies. + + +Pre-requisites +~~~~~~~~~~~~~~ + +.. + Any tasks to be performed before starting the procedures, checklists, + software requirements, required users and roles, etc. + Optional section. + +You can link to `other resources <https://example.com/>`_. + + +Steps +~~~~~ + +.. + Copy the following step as many times as you need. + + +#. This is the first step of the procedure. + +.. note:: + You can add a note with additional information needed to perform the step. + +You can include commands to be executed, for example: + +.. code-block:: bash + + sudo apt-get install git -y + +You can add an image, for example, a screenshot of the GUI: + +.. figure:: https://www.onap.org/wp-content/uploads/sites/20/2017/02/logo_onap_2017.png + :alt: Example image + :width: 50 % + +.. + Add the result of the step or procedure at the end of the chapter. + If there are verification steps, add them, as well. |