diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/OCLIP.rst | 9 | ||||
| -rw-r--r-- | docs/architecture.rst | 8 | ||||
| -rw-r--r-- | docs/console.rst | 6 | ||||
| -rw-r--r-- | docs/developer_guide.rst | 2 | ||||
| -rw-r--r-- | docs/index.rst | 13 | ||||
| -rw-r--r-- | docs/release-notes.rst | 2 | ||||
| -rw-r--r-- | docs/user_guide.rst | 4 |
7 files changed, 21 insertions, 23 deletions
diff --git a/docs/OCLIP.rst b/docs/OCLIP.rst index 837dae20..47e20c38 100644 --- a/docs/OCLIP.rst +++ b/docs/OCLIP.rst @@ -26,10 +26,5 @@ Advantages * Helps Operator/user to create new commands/fix the existing commands just by modifying the YAML file, so User no need to wait for an release time to get the fix for a bug or new commands. * Similar to Tomcat for deploying more than one webapps, on OCLIP, multiple's products commands could be deployed and executed. -This platform defines Open Command Specification (OCS) for CLI, which is similar to the Open API specification (OAS) defined by swagger for REST API. It is like : **API for developers, CLI for admins/users/operators !** For more details of OCS :ref:`open_cli_schema_version_1_0` - - -.. toctree:: - :maxdepth: 1 - - open_cli_schema_version_1_0.rst +This platform defines Open Command Specification (OCS) for CLI, which is similar to the Open API specification (OAS) defined by swagger for REST API. It is like : **API for developers, CLI for admins/users/operators !** +For more details of OCS :ref:`open_cli_schema_version_1_0` diff --git a/docs/architecture.rst b/docs/architecture.rst index 8e961a1b..fe17190f 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -11,12 +11,12 @@ Following diagram shows the high-level architecture of ONAP CLI. .. image:: images/portal-cli-arch.png -* **Command Registrar** : Registrar keeps track of the commands regsitered in ONAP CLI and when user invokes the command, it identify - the corresponding command route the request to that command plugin. +* **Command Registrar** : Registrar keeps track of the commands registered in ONAP CLI and when user invokes the command, it identify + the corresponding command route the request to that command plug-in. -* **Command Discoverer** : Discoverer discovers the commands both in plug-in format and YAML and auto-matically register them into Registrar. +* **Command Discoverer** : Discoverer discovers the commands both in plug-in format and YAML and automatically register them into Registrar. -* **Command Plug-ings** : Implement the command as plugin. More details :ref:`cli_developer_guide` +* **Command Plug-ing** : Implement the command as plug-in. More details :ref:`cli_developer_guide` * **HTTP Command** : Plug-in for implementing all Rest based command as YAML without any coding. diff --git a/docs/console.rst b/docs/console.rst index 83d75b68..5b65268e 100644 --- a/docs/console.rst +++ b/docs/console.rst @@ -11,10 +11,12 @@ Please install the CLI by following guidelines provided in :ref:`OOM_and_HEAT_ba After installation, ONAP CLI can be used in following form: -# Command Shell +Command Shell +-------------- .. image:: images/portal-cli-shell.png -# Web Command Console +Web Command Console +-------------------- .. image:: images/portal-cli-web-con.png diff --git a/docs/developer_guide.rst b/docs/developer_guide.rst index 2e2278e5..2a94a168 100644 --- a/docs/developer_guide.rst +++ b/docs/developer_guide.rst @@ -72,7 +72,7 @@ Note the following points: #. Now the command is ready. Build the project by running 'mvn clean install'. ONAP CLI framework automatically delivers these commands as part of the ONAP CLI zip file as part of this build. -#. To test this command, run the command 'onap hello-world --name amesterdam' +#. To test this command, run the command 'onap hello-world --name amsterdam' As a YAML --------- diff --git a/docs/index.rst b/docs/index.rst index 7a53a0b0..2ce041d0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,11 +13,11 @@ ONAP CLI Both Information and Communication Technology customers prefer Command Line Interface (CLI) over Graphical user interface (GUI) in many situations -such as automation, devops, CI&CD. So CLI is always been as integral part +such as automation, Devops, CI&CD. So CLI is always been as integral part of software products and platforms. ONAP CLI provides the command line interface for ONAP functionalities and in -Amesterdam release, it provides commands for following features: +Amsterdam release, it provides commands for following features: * ONAP micro-service discovery * ONAP external system and VNF cloud on-boarding @@ -25,14 +25,10 @@ Amesterdam release, it provides commands for following features: * ONAP VSP on-boarding * ONAP network service life-cycle management -ONAP CLI is developed using the industry first CLI platform called -**Open CLI Platform (oclip)** which is part of ONAP CLI deliverables. - .. toctree:: :maxdepth: 1 console.rst - OCLIP.rst architecture.rst developer_guide.rst user_guide.rst @@ -40,3 +36,8 @@ ONAP CLI is developed using the industry first CLI platform called OOM_and_HEAT_based_deployment.rst logging.rst release-notes.rst + + +========================== + +Powered by :ref:`OCLIP`
\ No newline at end of file diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 29dc04a8..49e4b7aa 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -18,7 +18,7 @@ NOTE: ONAP portal does not support following features, so user is recommended to **New Features** -* ONAP CLI available as nexus artifacts and docker images. +* ONAP CLI available as Nexus artifacts and docker images. For more details, :ref:`cli_installation_guide`. * It is delivered as part of portal installation during HEAT based installation. Also its supported in OOM as well. For more details, :ref:`OOM_and_HEAT_based_deployment`. diff --git a/docs/user_guide.rst b/docs/user_guide.rst index 37ac770d..919bb66c 100644 --- a/docs/user_guide.rst +++ b/docs/user_guide.rst @@ -33,7 +33,7 @@ And use the directive set to set the values for following parameters: Set the product version ------------------------ CLI framework is enhanced to handle multiple product versions at same -time. so to choose the product version, set evironment variable +time. so to choose the product version, set environment variable **CLI_PROUDCT_VERSION**. NOTE: In interactive mode, product version can be selected using @@ -43,7 +43,7 @@ Run *onap [-v|--version]* to see the CLI and available product version details Set the parameter values ------------------------ -Use the directive 'set' for setting the values for parameters and 'unset' for un-seting the values. +Use the directive 'set' for setting the values for parameters and 'unset' for reseting the values. Help ---- |