diff options
| author |   sindhu3672 <arcot.sindhuri@huawei.com> | 2019-08-07 11:14:01 +0530 |
|---|---|---|
| committer | sindhu3672 <arcot.sindhuri@huawei.com> | 2019-08-08 12:10:48 +0530 |
| commit | 229c5d3c6b196a9b2e5bfa5513a2eb7297ed04b4 (patch) | |
| tree | 5d8ef8f88a28502f68fee27be5688bf5899e2969 | |
| parent | fe0d58756ea86d152fbc5b8139c54aa1b52030db (diff) | |
Cli docs improvement
Documents enhancements for cli docs
Issue-ID: CLI-196
Signed-off-by: sindhu3672 <arcot.sindhuri@huawei.com>
Change-Id: Ifc96cade9970a493d182d63a90f4fcbd3f3046e8
| -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 |
3 files changed, 8 insertions, 8 deletions
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. |