diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/OCLIP.rst | 4 | ||||
| -rw-r--r-- | docs/architecture.rst | 2 | ||||
| -rw-r--r-- | docs/console.rst | 4 | ||||
| -rw-r--r-- | docs/installation_guide.rst | 4 | ||||
| -rw-r--r-- | docs/release-notes.rst | 12 |
5 files changed, 8 insertions, 18 deletions
diff --git a/docs/OCLIP.rst b/docs/OCLIP.rst index 56d3b9d2..837dae20 100644 --- a/docs/OCLIP.rst +++ b/docs/OCLIP.rst @@ -7,9 +7,7 @@ Open CLI Platform (OCLIP) ========================= -.. role:: blue - -:blue:`No coding, just texting !` +**No coding, just texting !** In Telco/IT world, Any software platform/platform with out CLI is considered as in-complete and as there is no platform exists today for implementing CLI, similar to Tomcat exists for HTTP applications, and followings are the main problems: diff --git a/docs/architecture.rst b/docs/architecture.rst index 6562dd85..8e961a1b 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -10,8 +10,6 @@ CLI architecture Following diagram shows the high-level architecture of ONAP CLI. .. image:: images/portal-cli-arch.png - :height: 600px - :width: 800px * **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. diff --git a/docs/console.rst b/docs/console.rst index 2b3b1345..83d75b68 100644 --- a/docs/console.rst +++ b/docs/console.rst @@ -14,11 +14,7 @@ After installation, ONAP CLI can be used in following form: # Command Shell .. image:: images/portal-cli-shell.png - :height: 600px - :width: 800px # Web Command Console .. image:: images/portal-cli-web-con.png - :height: 600px - :width: 800px diff --git a/docs/installation_guide.rst b/docs/installation_guide.rst index dc02bcc5..f1b99b13 100644 --- a/docs/installation_guide.rst +++ b/docs/installation_guide.rst @@ -46,14 +46,10 @@ Please follow the instructions given below, for installing CLI from portal. 1. After installing Portal, ONAP CLI will be available as Portal application as shown below: .. image:: images/portal-cli-app.png - :height: 600px - :width: 800px 2. Click on CLI application and it will show the following page and download the CLI as reported in this page. .. image:: images/portal-cli-dowload.png - :height: 600px - :width: 800px 3. After downloading, please follow the instruction given in this page to install ONAP CLI. diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 63b04422..29dc04a8 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -8,26 +8,28 @@ Version: 1.1.0 :Release Date: 2017-11-16 -ONAP CLI helps user to perform any operations over ONAP from command line, Linux console and web-console and following features are only -available over CLI and portal/vid does not support them: +ONAP CLI helps user to perform any operations over ONAP from command line, Linux console and web-console. + +NOTE: ONAP portal does not support following features, so user is recommended to use them over CLI: * Customer and subscription management * VNF Cloud on-boarding * VNF tenant on-boarding **New Features** + * 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`. -* Released first version of Open Command Line Interface Platform (OCLIP), industry first CLI platform for implementing CLI **just by texting (YAML) and no coding** . +* Released first version of **Open Command Line Interface Platform (OCLIP)**, industry first CLI platform for implementing CLI **just by texting (YAML) and no coding** . For more details, :ref:`OCLIP`. * It provides **Open Command Specification (OCS) 1.0** for defining the commands in YAML format, similar to Open API Specification (API). For more details, :ref:`open_cli_schema_version_1_0`. * All Onap commands are developed using OCLIP by authoring set of YAML files. For more details, :ref:`cli_cmd_help`. * All commands are tested completely and samples also provided for reference. - For more details, :ref:`cli_sample`. + For more details, :ref:`_cli_cmd_sample`. * User could develop new commands on-the-fly and deploy it and use. For more details, :ref:`cli_developer_guide`. @@ -36,4 +38,4 @@ available over CLI and portal/vid does not support them: * VF customizationUUID is not available over SDC REST API, so user is recommended to refer it from SDC portal * CLI impersonate VID as source while creating service, vf and vf-modules, due to SO limitation (SO-272) * vsp-add-artifact command sometime fails to upload the file, in that case, please use option -d to see the debug information -* + |