X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fguides%2Fonap-developer%2Fhow-to-use-docs%2Ftemplates%2Fsections%2Fadministration.rst;h=841a55291d146e1ab543942d13c66e3af4bd94c2;hb=32d2daf4c1c9a01c6cc6e9b4218b9f4d2650b8e8;hp=94a74071890c044d45734abdf161e5f22cb6a1ac;hpb=c7d15886be96f3036709bb0acc4beb7169e8eec1;p=doc.git diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/administration.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/administration.rst index 94a740718..841a55291 100644 --- a/docs/guides/onap-developer/how-to-use-docs/templates/sections/administration.rst +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/administration.rst @@ -1,24 +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 ============== - -.. note:: +.. * 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. - + the component. * This section is typically: provided for platform-component or applications; and - referenced in user guides - + referenced in user guides. * This note must be removed after content has been added. -Processes +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 `_. + + +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 % -Actions -------- +.. + Add the result of the step or procedure at the end of the chapter. + If there are verification steps, add them, as well.