CLI documents over all structure 29/13329/1
authorKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
Tue, 19 Sep 2017 07:04:43 +0000 (12:34 +0530)
committerKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
Tue, 19 Sep 2017 07:04:43 +0000 (12:34 +0530)
CLI-40

Change-Id: I933acfb653c5f9f3a746dd922e63810723f85281
Signed-off-by: Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
docs/OCLIP.rst [new file with mode: 0644]
docs/developer_guide.rst [new file with mode: 0644]
docs/index.rst
docs/installation_guide.rst [new file with mode: 0644]
docs/user_guide.rst [new file with mode: 0644]

diff --git a/docs/OCLIP.rst b/docs/OCLIP.rst
new file mode 100644 (file)
index 0000000..28ebed1
--- /dev/null
@@ -0,0 +1,12 @@
+.. _OCLIP:
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 Huawei Technologies Co., Ltd.
+
+Open CLI Platform
+=================
+
+.. toctree::
+   :maxdepth: 1
+
+   open_cli_schema_version_1_0.rst
\ No newline at end of file
diff --git a/docs/developer_guide.rst b/docs/developer_guide.rst
new file mode 100644 (file)
index 0000000..084e67b
--- /dev/null
@@ -0,0 +1,7 @@
+.. _developer_guide:
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 Huawei Technologies Co., Ltd.
+
+CLI developer guide
+===================
\ No newline at end of file
index 9aba9c6..1ad0b76 100644 (file)
@@ -4,10 +4,36 @@
 
 .. _cli_index:
 
-CLI Documentation
-==================
+ONAP CLI
+========
+
+.. role:: blue
+
+:blue:`One Command to command whole ONAP !`
+
+Both Information and Communication Technology customers prefer Command Line
+Interface (CLI) over Graphical user interface (GUI) in many situations
+such as automation, devops, CI&CD. So CLI is always been as integral part
+of software products and platforms.
+
+ONAP CLI provides the command line interface for ONAP functionalities and in
+Amesterdam release, it provides commands for following features:
+
+* ONAP micro-service discovery
+* ONAP external system and VNF cloud on-boarding
+* ONAP customer and subscription management
+* ONAP VSP on-boarding
+* ONAP network service life-cycle management
+
+ONAP CLI is developed using the industry first CLI platform called
+**Open CLI Platform (oclip)** which is part of ONAP CLI deliverables.
 
 .. toctree::
    :maxdepth: 1
 
+   OCLIP.rst
+   developer_guide.rst
+   user_guide.rst
+   installation_guide.rst
    open_cli_schema_version_1_0.rst
+
diff --git a/docs/installation_guide.rst b/docs/installation_guide.rst
new file mode 100644 (file)
index 0000000..3a55e57
--- /dev/null
@@ -0,0 +1,7 @@
+.. _installation_guide:
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 Huawei Technologies Co., Ltd.
+
+CLI installation guide
+======================
\ No newline at end of file
diff --git a/docs/user_guide.rst b/docs/user_guide.rst
new file mode 100644 (file)
index 0000000..fc0bee8
--- /dev/null
@@ -0,0 +1,7 @@
+.. _user_guide:
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 Huawei Technologies Co., Ltd.
+
+CLI User guide
+==============