diff options
| author |   sindhu3672 <arcot.sindhuri@huawei.com> | 2019-08-06 20:39:31 +0530 |
|---|---|---|
| committer | sindhu3672 <arcot.sindhuri@huawei.com> | 2019-08-06 20:39:31 +0530 |
| commit | 59a19fc2b4ffc2d6765fbd77696afd61a550929b (patch) | |
| tree | 28f4b457cf10bf2b56ba425745524c06a5ebd11c /docs | |
| parent | fe0d58756ea86d152fbc5b8139c54aa1b52030db (diff) | |
Documents improvement for cli docs
Documents enhancements for cli docs
Issue-ID: CLI-196
Signed-off-by: sindhu3672 <arcot.sindhuri@huawei.com>
Change-Id: I43e1d0d0ed5b47e514196d5b208a6dc30e43c2da
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/architecture.rst | 4 | ||||
| -rw-r--r-- | docs/cmd_help.rst | 4 | ||||
| -rw-r--r-- | docs/cmd_help_onap_amsterdam.rst | 4 |
3 files changed, 6 insertions, 6 deletions
diff --git a/docs/architecture.rst b/docs/architecture.rst index aef51b61..81d0195f 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -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. diff --git a/docs/cmd_help.rst b/docs/cmd_help.rst index f45d0f75..a3139452 100644 --- a/docs/cmd_help.rst +++ b/docs/cmd_help.rst @@ -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. diff --git a/docs/cmd_help_onap_amsterdam.rst b/docs/cmd_help_onap_amsterdam.rst index 1bc0985a..c18412d7 100644 --- a/docs/cmd_help_onap_amsterdam.rst +++ b/docs/cmd_help_onap_amsterdam.rst @@ -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 |