Removed useless curly braces around statement and useless return keyword
[cli.git] / docs / index.rst
index 833e1aa..8778fdd 100644 (file)
@@ -1,8 +1,56 @@
 .. 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.
+.. _master_index:
+
+.. _cli_index:
+
+ONAP CLI
+========
+
+.. role:: blue
+
+:blue:`One Command to command whole ONAP !`
+
+Introduction
+-------------
+
+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 is built using industry first CLI platform :ref:`OCLIP` and provides
+the commands for following ONAP functionalities:
+
+* Micro-service discovery
+* External system and VNF cloud on-boarding
+* Customer and subscription management
+* Product and service management
+* Network service life-cycle management
+* Policy management
+* VNF/PNF management
+
+Table of contents
+------------------
+
+Following guidelines provides detailed information about CLI.
 
-TODO Add files to toctree and delete this header
-------------------------------------------------
 .. toctree::
    :maxdepth: 1
 
+   cookbook.rst
+   console.rst
+   architecture.rst
+   developer_guide.rst
+   user_guide.rst
+   installation_guide.rst
+   OOM_and_HEAT_based_deployment.rst
+   logging.rst
+   release-notes.rst
+   trouble_shooting_guide.rst
+
+
+==========================
 
+Powered by :ref:`OCLIP`
\ No newline at end of file