docs/guides/onap-developer/how-to-use-docs/templates/sections/userinterfaces.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 User Interfaces
   6 ================
   7
   8 ..
   9    * This section is used to describe a software component's command line and graphical
  10      user interfaces.
  11
  12    * This section is typically: provided for a platform-component and application; and
  13      referenced from  user guides.
  14
  15 Graphical user interface (GUI)
  16 ------------------------------
  17
  18 ..
  19   * Describe how to access the GUI, including user roles/credentials, browser
  20   requirements, etc.
  21   * Describe how to access and use the basic functionalities related to the
  22   given component. Include screenshots wherever possible.
  23
  24 Command Line Interface (CLI)
  25 ----------------------------
  26
  27 ..
  28   * Describe how to access the CLI, including user roles/credentials.
  29   * Include the CLI reference here, with descriptions and examples of commands
  30   and parameters.