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 e551b53..62e7493 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -12,13 +12,14 @@ CONTROLLER DESIGN STUDIO (CDS)
 
 Introduction
 ------------
-    The system is designed to be self service, which means that users, not just
+
+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
+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
 its parameters and create a new service without writing a single line of code.
@@ -27,18 +28,19 @@ 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)
 
-    The GUI handles direct user input and allows for displaying both design time
+The GUI handles direct user input and allows for displaying both design time
 and run time activities. For design time, it allows for the creation of
 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,
+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
 Design Studio is to create and populate a controller blueprint, create a
@@ -51,11 +53,11 @@ configuration file (configlet) to a VNF/PNF.
 Modeling Concept
 ----------------
 
-    In Dublin release, the CDS community has contributed a framework to automate
+In Dublin release, the CDS community has contributed a framework to automate
 the resolution of resources for instantiation and any config provisioning
 operation, such as day0, day1 or day2 configuration.
 
-    The content of the CBA Package is driven from a catalog of reusable data
+The content of the CBA Package is driven from a catalog of reusable data
 dictionary, component and workflow, delivering a reusable and simplified
 self service experience.
 
@@ -77,8 +79,6 @@ Modeling Concept Links:
    :maxdepth: 1
 
    modelingconcepts/index
-   microservices/controllerBlueprintMS
-   microservices/blueprintsProcessorMS
 
 Scripts
 -------
@@ -107,15 +107,15 @@ Library
 .. |cdsArchitectureImage| image:: media/CDS_architecture.jpg
    :width: 500pt
 
-User Guide
-----------
+User Guides
+------------
 
 .. toctree::
    :maxdepth: 3
 
-   userguide/developer-guide
-   userguide/installation
-   userguide/designtime
+   userguides/developer-guide/index
+   userguides/installation
+   userguides/design-time-guide/designtime
 
 Use Cases
 ---------
@@ -131,7 +131,16 @@ CDS Designer UI
 .. toctree::
    :maxdepth: 2
 
-   ui/designer
+   ui/designer-guide
+
+
+Offered APIs
+----------------------------------
+
+.. toctree::
+   :maxdepth: 3
+
+   api-reference/index
 
 
 Controller Design Studio Presentation