diff options
| author |   Andrea Visnyei <andrea.visnyei@nokia.com> | 2020-12-09 12:26:35 +0100 |
|---|---|---|
| committer |   Eric Debeau <eric.debeau@orange.com> | 2021-05-06 15:36:12 +0200 |
| commit | 32d2daf4c1c9a01c6cc6e9b4218b9f4d2650b8e8 (patch) | |
| tree | 037bd4cf5220935b9f405d3db64e9b5b5e01eafe /docs/guides/onap-developer/how-to-use-docs/templates/sections/userinterfaces.rst | |
| parent | c7d15886be96f3036709bb0acc4beb7169e8eec1 (diff) | |
Template updates - sections
Instructions and examples added, notes commented out, review comments implemented
Add example.com in the linkcheck_ignore
Issue-ID: DOC-696
Change-Id: I8221ba6f2adce534ced7d8c06fbc7f23eef39efe
Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
Diffstat (limited to 'docs/guides/onap-developer/how-to-use-docs/templates/sections/userinterfaces.rst')
| -rw-r--r-- | docs/guides/onap-developer/how-to-use-docs/templates/sections/userinterfaces.rst | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/userinterfaces.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/userinterfaces.rst new file mode 100644 index 000000000..0f6a6cb38 --- /dev/null +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/userinterfaces.rst @@ -0,0 +1,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. |