diff options
| author |   Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com> | 2017-09-19 12:34:43 +0530 |
|---|---|---|
| committer | Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com> | 2017-09-19 12:34:43 +0530 |
| commit | 8bb3da942a0abf05f91cd1802d50ed4fe256c9af (patch) | |
| tree | ff468f603d269dd268268eeb5c838f69829aafff /docs | |
| parent | 87f328098821dc38d156b20d0c8e3d2a5ac7e9c4 (diff) | |
CLI documents over all structure
CLI-40
Change-Id: I933acfb653c5f9f3a746dd922e63810723f85281
Signed-off-by: Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/OCLIP.rst | 12 | ||||
| -rw-r--r-- | docs/developer_guide.rst | 7 | ||||
| -rw-r--r-- | docs/index.rst | 30 | ||||
| -rw-r--r-- | docs/installation_guide.rst | 7 | ||||
| -rw-r--r-- | docs/user_guide.rst | 7 |
5 files changed, 61 insertions, 2 deletions
diff --git a/docs/OCLIP.rst b/docs/OCLIP.rst new file mode 100644 index 00000000..28ebed1d --- /dev/null +++ b/docs/OCLIP.rst @@ -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 index 00000000..084e67bd --- /dev/null +++ b/docs/developer_guide.rst @@ -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 diff --git a/docs/index.rst b/docs/index.rst index 9aba9c6b..1ad0b76a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 index 00000000..3a55e578 --- /dev/null +++ b/docs/installation_guide.rst @@ -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 index 00000000..fc0bee8a --- /dev/null +++ b/docs/user_guide.rst @@ -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 +============== |