summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-developer/how-to-use-docs/templates/sections/administration.rst
blob: 841a55291d146e1ab543942d13c66e3af4bd94c2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
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.