diff options
| author |   thmsdt <thomas.kulik@telekom.de> | 2022-08-02 13:28:17 +0200 |
|---|---|---|
| committer | thmsdt <thomas.kulik@telekom.de> | 2022-08-04 11:51:51 +0200 |
| commit | 21d59414fca273aade30aa4209aca9bb35a5f78f (patch) | |
| tree | bd1a7449fddb04204f3c759b2877b49f92fe6a17 /docs/guides/onap-documentation/templates/sections/userinterfaces.rst | |
| parent | 830bc298c26764f3d98f3ca98adf7b3c1b3d0a3a (diff) | |
update and rearrange documentation related content
Issue-ID: DOC-798
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: Id454ec5f09903efb81123669e6eb024f21a08797
Diffstat (limited to 'docs/guides/onap-documentation/templates/sections/userinterfaces.rst')
| -rw-r--r-- | docs/guides/onap-documentation/templates/sections/userinterfaces.rst | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/guides/onap-documentation/templates/sections/userinterfaces.rst b/docs/guides/onap-documentation/templates/sections/userinterfaces.rst new file mode 100644 index 000000000..0f6a6cb38 --- /dev/null +++ b/docs/guides/onap-documentation/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. |