Documentation changes for vFW CNF use case and CNFO

[ccsdk/cds.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index bf6bba5..62e7493 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -12,11 +12,13 @@ CONTROLLER DESIGN STUDIO (CDS)
 
 Introduction
 ------------
+
 The system is designed to be self service, which means that users, not just
 programmers, can reconfigure the software system as needed to meet customer
 requirements. To accomplish this goal, the system is built around models that
 provide for real-time changes in how the system operates.  Users merely need
 to change a model to change how a service operates.
+
 Self service is a completely new way of delivering services.  It removes the
 dependence on code releases and the delays they cause and puts the control of
 services into the hands of the service providers.  They can change a model and
@@ -26,6 +28,7 @@ deliver products that more closely match the needs of its customers.
 
 Architecture
 ------------
+
 The Controller Design Studio is composed of two major components:
    * The GUI (or frontend)
    * The Run Time (or backend)
@@ -36,6 +39,7 @@ controller blueprint, from selecting the DGs to be included, to incorporating
 the artifact templates, to adding necessary components.  For run time, it
 allows the user to direct the system to resolve the unresolved elements of the
 controller blueprint and download the resulting configuration into a VNF.
+
 At a more basic level, it allows for creation of data dictionaries,
 capabilities catalogs, and controller blueprint, the basic elements that are
 used to generate a configuration. The essential function of the Controller
@@ -66,7 +70,7 @@ https://github.com/onap/ccsdk-cds/tree/master/components/model-catalog/definitio
 
 Tosca Model Reference:
 
-|image0|
+|toscaModel|
 
 Modeling Concept Links:
 ~~~~~~~~~~~~~~~~~~~~~~~
@@ -74,22 +78,7 @@ Modeling Concept Links:
 .. toctree::
    :maxdepth: 1
 
-   modelingconcepts/overview
-   microservices/controllerBlueprintStudioProcessorMS
-   microservices/bluePrintsProcessorMS
-   microservices/expression
-   microservices/dynamicapi
-   microservices/flexibleplugin
-
-
-Design tools
-------------
-.. toctree::
-   :maxdepth: 1
-   :glob:
-
-   CBA/index
-   datadictionary/index
+   modelingconcepts/index
 
 Scripts
 -------
@@ -99,46 +88,63 @@ Library
 
 * NetconfClient
 
-In order to facilitate NETCONF interaction within scripts, a python NetconfClient binded to our Kotlin implementation is made available. This NetconfClient can be used when using the component-netconf-executor.
+    In order to facilitate NETCONF interaction within scripts, a python NetconfClient binded to our Kotlin implementation is made available. This NetconfClient can be used when using the component-netconf-executor.
 
-The client can be find here: https://github.com/onap/ccsdk-cds/blob/master/components/scripts/python/ccsdk_netconf/netconfclient.py
+    The client can be find here: https://github.com/onap/ccsdk-cds/blob/master/components/scripts/python/ccsdk_netconf/netconfclient.py
 
 * ResolutionHelper
 
-When executing a component executor script, designer might want to perform
-resource resolution along with template meshing directly from the script
-itself.
+    When executing a component executor script, designer might want to perform
+    resource resolution along with template meshing directly from the script
+    itself.
+
+    The helper can be found in below link:
+    https://github.com/onap/ccsdk-apps/blob/master/components/scripts/python/ccsdk_netconf/common.py
+
+.. |toscaModel| image:: media/tosca_model.jpg
+   :width: 500pt
 
-The helper can be found in below link: 
-https://github.com/onap/ccsdk-apps/blob/master/components/scripts/python/ccsdk_netconf/common.py
+.. |cdsArchitectureImage| image:: media/CDS_architecture.jpg
+   :width: 500pt
 
-.. |image0| image:: media/tosca_model.jpg
-   :width: 7.88889in
-   :height: 4.43750in
+User Guides
+------------
+
+.. toctree::
+   :maxdepth: 3
 
-.. |cdsArchitectureImage| image:: media/CDS_architecture_latest.png
-   :scale: 30 %
-   
-User Guide
-----------
+   userguides/developer-guide/index
+   userguides/installation
+   userguides/design-time-guide/designtime
+
+Use Cases
+---------
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
-   installation
-   designtime
+   usecases/use-cases
 
-CDS Desginer UI
+CDS Designer UI
 ---------------
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
+
+   ui/designer-guide
+
+
+Offered APIs
+----------------------------------
+
+.. toctree::
+   :maxdepth: 3
+
+   api-reference/index
 
-   CDS_Designer_Guide
-  
 
 Controller Design Studio Presentation
 -------------------------------------
 
 Details about CDS Architecture and Design detail, Please click the link.
-:download:`CDS_Architecture_Design.pptx`
+:download:`CDS_Architecture_Design <media/CDS_Architecture_Design.pptx>`