Doc content format

Index file and user guide format
Change-Id: I5e0de701d4c86d877286d7e6a16673129622c77b
Issue-ID: CCSDK-1453
Signed-off-by: Ezhilarasi <ezhrajam@in.ibm.com>

diff --git a/docs/index.rst b/docs/index.rst
index 183bbbf..0e43fd5 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -96,14 +96,12 @@ 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.
 
 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
@@ -126,7 +124,8 @@ User Guide
 .. toctree::
    :maxdepth: 1
 
-   userguide
+   installation
+   designtime
   
 
 Controller Design Studio Presentation

diff --git a/docs/installation.rst b/docs/installation.rst
index ac72b42..2f9ce48 100644 (file)
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -3,19 +3,19 @@
 .. Copyright (C) 2019 IBM.
 
 Installation
-============
+------------
 
 ONAP is meant to be deployed within a Kubernetes environment. Hence, the de-facto way to deploy CDS is through Kubernetes.
 
 ONAP also package Kubernetes manifest as Chart, using Helm.
 
 Prerequisite
-============
+------------
 
 https://docs.onap.org/en/latest/guides/onap-developer/settingup/index.html
 
 Setup local Helm
-================
+----------------
 
 helm repo
 
@@ -23,7 +23,7 @@ helm repo
 * helm repo add local http://127.0.0.1:8879
 
 Get the chart
-=============
+-------------
 
 Make sure to checkout the release to use, by replacing $release-tag in bellow command
 
@@ -33,31 +33,34 @@ cd oom/kubernetes
 make cds
 
 Install CDS
-===========
+-----------
 
 helm install --name cds cds
 
 Result
-======
-
-$ kubectl get all --selector=release=cds
-NAME                                             READY     STATUS    RESTARTS   AGE
-pod/cds-blueprints-processor-54f758d69f-p98c2    0/1       Running   1          2m
-pod/cds-cds-6bd674dc77-4gtdf                     1/1       Running   0          2m
-pod/cds-cds-db-0                                 1/1       Running   0          2m
-pod/cds-controller-blueprints-545bbf98cf-zwjfc   1/1       Running   0          2m
-NAME                            TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)             AGE
-service/blueprints-processor    ClusterIP   10.43.139.9     <none>        8080/TCP,9111/TCP   2m
-service/cds                     NodePort    10.43.254.69    <none>        3000:30397/TCP      2m
-service/cds-db                  ClusterIP   None            <none>        3306/TCP            2m
-service/controller-blueprints   ClusterIP   10.43.207.152   <none>        8080/TCP            2m
-NAME                                        DESIRED   CURRENT   UP-TO-DATE   AVAILABLE   AGE
-deployment.apps/cds-blueprints-processor    1         1         1            0           2m
-deployment.apps/cds-cds                     1         1         1            1           2m
-deployment.apps/cds-controller-blueprints   1         1         1            1           2m
-NAME                                                   DESIRED   CURRENT   READY     AGE
-replicaset.apps/cds-blueprints-processor-54f758d69f    1         1         0         2m
-replicaset.apps/cds-cds-6bd674dc77                     1         1         1         2m
-replicaset.apps/cds-controller-blueprints-545bbf98cf   1         1         1         2m
-NAME                          DESIRED   CURRENT   AGE
-statefulset.apps/cds-cds-db   1         1         2m
\ No newline at end of file
+------
+
+.. code-block:: json
+   :linenos:
+   
+   $ kubectl get all --selector=release=cds
+   NAME                                             READY     STATUS    RESTARTS   AGE
+   pod/cds-blueprints-processor-54f758d69f-p98c2    0/1       Running   1          2m
+   pod/cds-cds-6bd674dc77-4gtdf                     1/1       Running   0          2m
+   pod/cds-cds-db-0                                 1/1       Running   0          2m
+   pod/cds-controller-blueprints-545bbf98cf-zwjfc   1/1       Running   0          2m
+   NAME                            TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)             AGE
+   service/blueprints-processor    ClusterIP   10.43.139.9     <none>        8080/TCP,9111/TCP   2m
+   service/cds                     NodePort    10.43.254.69    <none>        3000:30397/TCP      2m
+   service/cds-db                  ClusterIP   None            <none>        3306/TCP            2m
+   service/controller-blueprints   ClusterIP   10.43.207.152   <none>        8080/TCP            2m
+   NAME                                        DESIRED   CURRENT   UP-TO-DATE   AVAILABLE   AGE
+   deployment.apps/cds-blueprints-processor    1         1         1            0           2m
+   deployment.apps/cds-cds                     1         1         1            1           2m
+   deployment.apps/cds-controller-blueprints   1         1         1            1           2m
+   NAME                                                   DESIRED   CURRENT   READY     AGE
+   replicaset.apps/cds-blueprints-processor-54f758d69f    1         1         0         2m
+   replicaset.apps/cds-cds-6bd674dc77                     1         1         1         2m
+   replicaset.apps/cds-controller-blueprints-545bbf98cf   1         1         1         2m
+   NAME                          DESIRED   CURRENT   AGE
+   statefulset.apps/cds-cds-db   1         1         2m
\ No newline at end of file