summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-documentation/templates/sections/userinterfaces.rst
blob: 0f6a6cb38a9cf931c54c801a0322a904cf1ae069 (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
.. 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

User Interfaces
================

..
   * This section is used to describe a software component's command line and graphical
     user interfaces.

   * This section is typically: provided for a platform-component and application; and
     referenced from  user guides.

Graphical user interface (GUI)
------------------------------

..
  * Describe how to access the GUI, including user roles/credentials, browser
  requirements, etc.
  * Describe how to access and use the basic functionalities related to the
  given component. Include screenshots wherever possible.

Command Line Interface (CLI)
----------------------------

..
  * Describe how to access the CLI, including user roles/credentials.
  * Include the CLI reference here, with descriptions and examples of commands
  and parameters.