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

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright 2021 ONAP contributors, Nokia
   4
   5 Administration
   6 ==============
   7
   8 ..
   9    * This section is used to describe a software component from the perspective of on-going
  10      operation including regular processes and actions that are taken to configure and manage
  11      the component.
  12    * This section is typically: provided for platform-component or applications; and
  13      referenced in user guides.
  14    * This note must be removed after content has been added.
  15
  16
  17 Procedure
  18 ---------
  19
  20 ..
  21   Use this section for each procedure you want to include.
  22
  23
  24 Purpose
  25 ~~~~~~~
  26
  27 ..
  28   The purpose of the procedure, what is the intended outcome, possible
  29   dependencies.
  30
  31
  32 Pre-requisites
  33 ~~~~~~~~~~~~~~
  34
  35 ..
  36   Any tasks to be performed before starting the procedures, checklists,
  37   software requirements, required users and roles, etc.
  38   Optional section.
  39
  40 You can link to `other resources <https://example.com/>`_.
  41
  42
  43 Steps
  44 ~~~~~
  45
  46 ..
  47   Copy the following step as many times as you need.
  48
  49
  50 #. This is the first step of the procedure.
  51
  52 .. note::
  53   You can add a note with additional information needed to perform the step.
  54
  55 You can include commands to be executed, for example:
  56
  57 .. code-block:: bash
  58
  59    sudo apt-get install git -y
  60
  61 You can add an image, for example, a screenshot of the GUI:
  62
  63 .. figure:: https://www.onap.org/wp-content/uploads/sites/20/2017/02/logo_onap_2017.png
  64   :alt: Example image
  65   :width: 50 %
  66
  67 ..
  68   Add the result of the step or procedure at the end of the chapter.
  69   If there are verification steps, add them, as well.