Documents improvement for cli docs 21/92821/1
authorsindhu3672 <arcot.sindhuri@huawei.com>
Tue, 6 Aug 2019 15:09:31 +0000 (20:39 +0530)
committersindhu3672 <arcot.sindhuri@huawei.com>
Tue, 6 Aug 2019 15:09:31 +0000 (20:39 +0530)
Documents enhancements for cli docs

Issue-ID: CLI-196

Signed-off-by: sindhu3672 <arcot.sindhuri@huawei.com>
Change-Id: I43e1d0d0ed5b47e514196d5b208a6dc30e43c2da

docs/architecture.rst
docs/cmd_help.rst
docs/cmd_help_onap_amsterdam.rst

index aef51b6..81d0195 100644 (file)
@@ -12,7 +12,7 @@ Following diagram shows the high-level architecture of OCLIP.
 .. image:: images/portal-cli-arch.png
 
 * **Command Registrar** :  Registrar keeps track of the commands registered in OCLIP and when user invokes the command,
-it identify the corresponding command and helps to invoke the corresponding command plug-in.
+it identifies the corresponding command and helps to invoke the corresponding command plug-in.
 
 * **Command Discoverer** : Discoverer discovers the commands both in plug-in format and YAML and automatically register
 them into Registrar.
@@ -27,6 +27,6 @@ them into Registrar.
 
 * **Web Command Console** : Provides the interactive command line console from web-browser
 
-* **Cache** : Provides an persistent storage for discoverer to store the meta-data about the discovered Commands.
+* **Cache** : Provides persistent storage for discoverer to store the meta-data about the discovered Commands.
 
 * **open cli schemas** : Set of command YAML provides the CLI definitions.
index f45d0f7..a313945 100644 (file)
@@ -85,7 +85,7 @@ Error::
 
 usage: oclip basic-logout
 
-Provides HTTP basic authorization support. As part of logout, it invalidate authoirzation key generated while login.
+Provides HTTP basic authorization support. As part of logout, it invalidates authorization key generated while login.
 
 
 Product: open-cli
@@ -140,7 +140,7 @@ Error::
 usage: oclip catalog
 
 Provides catalog discovery support to find the base api path for given service from product's catalog service.
-Any product want to support catalog, it could derive from this command. Currently ONAP uses it and create
+If any product wants to support catalog, it could derive from this command. Currently ONAP uses it and creates
 derived command by using ONAP MSB service.
 
 
index 1bc0985..c18412d 100644 (file)
@@ -15,8 +15,8 @@ onap-amsterdam
 NOTE: EOL 01-Aug-2018
 
 
-ONAP Amsterdam was the first release of ONAP product after merging open-o and open-ecomp together.
-It provides platform to creating and maintaining the network services for VoLTE and vCPE types and
+ONAP Amsterdam is the first release of ONAP product after merging open-o and open-ecomp.
+It provides platform to create and maintain the network services for VoLTE and vCPE types.
 CLI provides following commands for operating ONAP with this support.
 
 [1] basic-login