diff options
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 | ||||
| -rw-r--r-- | docs/user_guide_end_to_end_onap_cli_commands.rst | 6 | ||||
| -rw-r--r-- | docs/user_guide_pnf_on_boarding.rst | 4 | ||||
| -rw-r--r-- | docs/user_guide_verification_program.rst | 6 |
6 files changed, 14 insertions, 14 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 diff --git a/docs/user_guide_end_to_end_onap_cli_commands.rst b/docs/user_guide_end_to_end_onap_cli_commands.rst index 9b595092..69204fdb 100644 --- a/docs/user_guide_end_to_end_onap_cli_commands.rst +++ b/docs/user_guide_end_to_end_onap_cli_commands.rst @@ -8,9 +8,9 @@ End-to-End command guide for working with ONAP ============================================== -This document demonstrate end to end working with ONAP using cli. +This document demonstrates end to end working with ONAP using cli. -In current state of ONAP, it is getting initialized by robot scritp (`demo.sh init`), +Currently, in ONAP, it is getting initialized by robot script (`demo.sh init`), which requires programming knowledge to modify the scripts as per the requirement. Cli provides an interface to communicate with different services in ONAP and it can be used to configure ONAP as per requirement without any programming knowledge. @@ -154,7 +154,7 @@ Run following command to create VSP. Add artifact to VSP ------------------- -This command will associate artifacts to VSP. +This command associates artifacts to VSP. :: diff --git a/docs/user_guide_pnf_on_boarding.rst b/docs/user_guide_pnf_on_boarding.rst index ef5c7e53..765db066 100644 --- a/docs/user_guide_pnf_on_boarding.rst +++ b/docs/user_guide_pnf_on_boarding.rst @@ -8,9 +8,9 @@ Step to import VNF/PNF ============================================== -This document describe how to insert existing PNF/VNF to AAI with CLI project. +This document describes how to insert existing PNF/VNF to AAI with CLI project. -The main step will include: +Main steps: 1. create customer and service instance in AAI. This step could be done by UUI or VID, OR user can insert customer/service instance node by CLI cmd. 2. create PNF/VNF diff --git a/docs/user_guide_verification_program.rst b/docs/user_guide_verification_program.rst index 462badb8..05bcb28b 100644 --- a/docs/user_guide_verification_program.rst +++ b/docs/user_guide_verification_program.rst @@ -13,9 +13,9 @@ in future it could be extended to other profile) for authoring the testing the C It provides the model based test environment where author needs to setup following aspects: -# Write the moco json which capture the HTTP request and response in moco style +# Write the moco JSON which captures the HTTP request and response in moco style -# Write the sample YAML which capture the one or more functional test case(s) +# Write the sample YAML which captures the one or more functional test case(s) # Place them under open-cli-sample directory under OPEN_CLI_HOME @@ -23,4 +23,4 @@ Once this setup is done, author can verify the OCS YAML by running the following oclip <command name> --verify | -V -It will list out the success/failure of each test cases written in sample YAML. +It will list out the success/failure of each test case written in sample YAML. |