Fix formatting issues in RST files

Fixed issues found in sphinx-build of documentation files

Issue-ID: CCSDK-2176
Signed-off-by: Dan Timoney <dtimoney@att.com>
Change-Id: I21f8012bc38e4fb22ee31c7d29d968b5775cf669

diff --git a/docs/conf.py b/docs/conf.py
index 8f40e8b..3b28eb7 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -12,4 +12,4 @@ intersphinx_mapping = {}
 html_last_updated_fmt = '%d-%b-%y %H:%M'
 
 def setup(app):
-    app.add_stylesheet("css/ribbon_onap.css")
+    app.add_css_file("css/ribbon_onap.css")

diff --git a/docs/datadictionary/complexResponse.rst b/docs/datadictionary/complexResponse.rst
index d32d13d..3864c48 100644 (file)
--- a/docs/datadictionary/complexResponse.rst
+++ b/docs/datadictionary/complexResponse.rst
@@ -8,14 +8,16 @@ complex Response code
 .. code-block:: json
    :linenos:
 
-   "id": 4,
-   "address": "192.168.10.2/32",
-   "vrf": null,
-   "tenant": null,
-   "status": 1,
-   "role": null,
-   "interface": null,
-   "description": "",
-   "nat_inside": null,
-   "created": "2018-08-30",
-   "last_updated": "2018-08-30T14:59:05.277820Z"
\ No newline at end of file
+   {
+      "id": 4,
+      "address": "192.168.10.2/32",
+      "vrf": null,
+      "tenant": null,
+      "status": 1,
+      "role": null,
+      "interface": null,
+      "description": "",
+      "nat_inside": null,
+      "created": "2018-08-30",
+      "last_updated": "2018-08-30T14:59:05.277820Z"
+   }

diff --git a/docs/datadictionary/create_netbox_ip_address.rst b/docs/datadictionary/create_netbox_ip_address.rst
index f6d83c5..3ba733a 100644 (file)
--- a/docs/datadictionary/create_netbox_ip_address.rst
+++ b/docs/datadictionary/create_netbox_ip_address.rst
@@ -3,9 +3,11 @@
 .. Copyright (C) 2019 IBM.
 
 create_netbox_ip_address code
-=============================
+============================= 
 
-{
+.. code-block:: json
+
+   {
     "tags" : "oam-local-ipv4-address",
     "name" : "create_netbox_ip",
     "property" : {
@@ -33,4 +35,4 @@ create_netbox_ip_address code
         }
       }
     }
-  }
+   }

diff --git a/docs/datadictionary/dbsystemcode.rst b/docs/datadictionary/dbsystemcode.rst
index d6cda5b..22bdb97 100644 (file)
--- a/docs/datadictionary/dbsystemcode.rst
+++ b/docs/datadictionary/dbsystemcode.rst
@@ -7,11 +7,13 @@ Dbsystemcode
 .. code-block:: json
    :linenos:
    
-   "dsl_definitions": {
-   "dynamic-db-source": {
-    "type": "maria-db",
-    "url": "jdbc:mysql://localhost:3306/sdnctl",
-    "username": <username>,
-    "password": <password>
+   {
+      "dsl_definitions": {
+         "dynamic-db-source": {
+            "type": "maria-db",
+            "url": "jdbc:mysql://localhost:3306/sdnctl",
+            "username": "<username>",
+            "password": "<password>"
+           }
+      }
    }
-   }
\ No newline at end of file

diff --git a/docs/datadictionary/resourcedefinitioncodesnip.rst b/docs/datadictionary/resourcedefinitioncodesnip.rst
index 6504a07..785614b 100644 (file)
--- a/docs/datadictionary/resourcedefinitioncodesnip.rst
+++ b/docs/datadictionary/resourcedefinitioncodesnip.rst
@@ -8,42 +8,44 @@ Source Capability Code
 .. code-block:: json
    :linenos:
    
-   "description": "This is Component Resource Source Node Type",
-   "version": "1.0.0",
-   "properties": {
-     "script-type": {
-       "required": true,
-       "type": "string",
-       "default": "kotlin",
-       "constraints": [
-         {
-           "valid_values": [
-             "kotlin",
-             "jython"
-           ]
-         }
-       ]
-     },
-     "script-class-reference": {
-       "description": "Capability reference name for internal and kotlin, for jython script file path",
-       "required": true,
-       "type": "string"
-     },
-     "instance-dependencies": {
-       "required": false,
-       "description": "Instance dependency Names to Inject to Kotlin / Jython Script.",
-       "type": "list",
-       "entry_schema": {
-         "type": "string"
-       }
-     },
-     "key-dependencies": {
-       "description": "Resource Resolution dependency dictionary names.",
-       "required": true,
-       "type": "list",
-       "entry_schema": {
-         "type": "string"
-       }
-     }
-   },
-   "derived_from": "tosca.nodes.ResourceSource"
\ No newline at end of file
+   {
+      "description": "This is Component Resource Source Node Type",
+      "version": "1.0.0",
+      "properties": {
+        "script-type": {
+          "required": true,
+          "type": "string",
+          "default": "kotlin",
+          "constraints": [
+            {
+              "valid_values": [
+                "kotlin",
+                "jython"
+              ]
+            }
+          ]
+        },
+        "script-class-reference": {
+          "description": "Capability reference name for internal and kotlin, for jython script file path",
+          "required": true,
+          "type": "string"
+        },
+        "instance-dependencies": {
+          "required": false,
+          "description": "Instance dependency Names to Inject to Kotlin / Jython Script.",
+          "type": "list",
+          "entry_schema": {
+            "type": "string"
+          }
+        },
+        "key-dependencies": {
+          "description": "Resource Resolution dependency dictionary names.",
+          "required": true,
+          "type": "list",
+          "entry_schema": {
+            "type": "string"
+          }
+        }
+      },
+      "derived_from": "tosca.nodes.ResourceSource"
+   }

diff --git a/docs/datadictionary/resourcesource.rst b/docs/datadictionary/resourcesource.rst
index 49ef6a1..4d4619a 100644 (file)
--- a/docs/datadictionary/resourcesource.rst
+++ b/docs/datadictionary/resourcesource.rst
@@ -2,7 +2,7 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. Copyright (C) 2019 IBM.
 
-Resource Source 
+Resource Source
 ---------------
 
 Input:
@@ -10,32 +10,37 @@ Input:
 Expects the value to be provided as input to the request.
 
 
-
 .. code-block:: json
    :linenos:
-
-   source-input
+   
    {
-    "description": "This is Input Resource Source Node Type",
-    "version": "1.0.0",
-    "properties": {},
-    "derived_from": "tosca.nodes.ResourceSource"
+     "source-input" : 
+     {
+       "description": "This is Input Resource Source Node Type",
+       "version": "1.0.0",
+       "properties": {},
+       "derived_from": "tosca.nodes.ResourceSource"
+     }
    }
 
 
+
 Default:
 ========
 Expects the value to be defaulted in the model itself.
 
+   
 .. code-block:: json
    :linenos:
-
-   source-default
+   
    {
-    "description": "This is Default Resource Source Node Type",
-    "version": "1.0.0",
-    "properties": {},
-    "derived_from": "tosca.nodes.ResourceSource"
+     "source-default" : 
+     {
+       "description": "This is Default Resource Source Node Type",
+       "version": "1.0.0",
+       "properties": {},
+       "derived_from": "tosca.nodes.ResourceSource"
+     }
    }
 
 

diff --git a/docs/datadictionary/restauth.rst b/docs/datadictionary/restauth.rst
index 9f62869..8051a6a 100644 (file)
--- a/docs/datadictionary/restauth.rst
+++ b/docs/datadictionary/restauth.rst
@@ -12,12 +12,14 @@ token-auth:
 .. code-block:: json
    :linenos:
    
-   "dsl_definitions": {
-     "dynamic-rest-source": {
-       "type" : "token-auth",
-       "url" : "http://localhost:32778",
-       "token" : <token>
-     }
+   {
+      "dsl_definitions": {
+        "dynamic-rest-source": {
+          "type" : "token-auth",
+          "url" : "http://localhost:32778",
+          "token" : "<token>"
+        }
+      }
    }
    
 basic-auth:
@@ -26,13 +28,15 @@ basic-auth:
 .. code-block:: json
    :linenos:
       
-   "dsl_definitions": {
-     "dynamic-rest-source": {
-       "type" : "basic-auth",
-       "url" : "http://localhost:32778",
-       "username" : <username>,
-       "password": <password>
-    }
+   {
+      "dsl_definitions": {
+        "dynamic-rest-source": {
+          "type" : "basic-auth",
+          "url" : "http://localhost:32778",
+          "username" : "<username>",
+          "password": "<password>"
+       }
+      }
    }
    
 ssl-basic-auth:
@@ -41,14 +45,16 @@ ssl-basic-auth:
 .. code-block:: json
    :linenos:
       
-   "dsl_definitions": {
-     "dynamic-rest-source": {
-       "type" : "ssl-basic-auth",
-       "url" : "http://localhost:32778",
-       "keyStoreInstance": "JKS or PKCS12",
-       "sslTrust": "trusture",
-       "sslTrustPassword": <password>,
-       "sslKey": "keystore",
-       "sslKeyPassword: <password>
-    }
-   }
\ No newline at end of file
+   {
+      "dsl_definitions": {
+        "dynamic-rest-source": {
+          "type" : "ssl-basic-auth",
+          "url" : "http://localhost:32778",
+          "keyStoreInstance": "JKS or PKCS12",
+          "sslTrust": "trusture",
+          "sslTrustPassword": "<password>",
+          "sslKey": "keystore",
+          "sslKeyPassword": "<password>"
+       }
+      }
+   }

diff --git a/docs/datadictionary/restsourcecode.rst b/docs/datadictionary/restsourcecode.rst
index 243a65c..c59bcd2 100644 (file)
--- a/docs/datadictionary/restsourcecode.rst
+++ b/docs/datadictionary/restsourcecode.rst
@@ -8,83 +8,85 @@ Rest Source Code:
 .. code-block:: json
    :linenos:
    
-   "description": "This is Rest Resource Source Node Type",
-   "version": "1.0.0",
-   "properties": {
-     "type": {
-       "required": false,
-       "type": "string",
-       "default": "JSON",
-       "constraints": [
-         {
-           "valid_values": [
-             "JSON"
-           ]
-         }
-       ]
-     },
-     "verb": {
-       "required": false,
-       "type": "string",
-       "default": "GET",
-       "constraints": [
-         {
-           "valid_values": [
-             "GET", "POST", "DELETE", "PUT"
-           ]
-         }
-       ]
-     },
-     "payload": {
-       "required": false,
-       "type": "string",
-       "default": ""
-     },
-     "endpoint-selector": {
-       "required": false,
-       "type": "string"
-     },
-     "url-path": {
-       "required": true,
-       "type": "string"
-     },
-     "path": {
-       "required": true,
-       "type": "string"
-     },
-     "expression-type": {
-       "required": false,
-       "type": "string",
-       "default": "JSON_PATH",
-       "constraints": [
-         {
-           "valid_values": [
-             "JSON_PATH",
-             "JSON_POINTER"
-           ]
-         }
-       ]
-     },
-     "input-key-mapping": {
-       "required": false,
-       "type": "map",
-       "entry_schema": {
-         "type": "string"
-       }
-     },
-     "output-key-mapping": {
-       "required": false,
-       "type": "map",
-       "entry_schema": {
-         "type": "string"
-       }
-     },
-     "key-dependencies": {
-       "required": true,
-       "type": "list",
-       "entry_schema": {
-         "type": "string"
-       }
-     }
-   },
-   "derived_from": "tosca.nodes.ResourceSource"
\ No newline at end of file
+   {
+      "description": "This is Rest Resource Source Node Type",
+      "version": "1.0.0",
+      "properties": {
+        "type": {
+          "required": false,
+          "type": "string",
+          "default": "JSON",
+          "constraints": [
+            {
+              "valid_values": [
+                "JSON"
+              ]
+            }
+          ]
+        },
+        "verb": {
+          "required": false,
+          "type": "string",
+          "default": "GET",
+          "constraints": [
+            {
+              "valid_values": [
+                "GET", "POST", "DELETE", "PUT"
+              ]
+            }
+          ]
+        },
+        "payload": {
+          "required": false,
+          "type": "string",
+          "default": ""
+        },
+        "endpoint-selector": {
+          "required": false,
+          "type": "string"
+        },
+        "url-path": {
+          "required": true,
+          "type": "string"
+        },
+        "path": {
+          "required": true,
+          "type": "string"
+        },
+        "expression-type": {
+          "required": false,
+          "type": "string",
+          "default": "JSON_PATH",
+          "constraints": [
+            {
+              "valid_values": [
+                "JSON_PATH",
+                "JSON_POINTER"
+              ]
+            }
+          ]
+        },
+        "input-key-mapping": {
+          "required": false,
+          "type": "map",
+          "entry_schema": {
+            "type": "string"
+          }
+        },
+        "output-key-mapping": {
+          "required": false,
+          "type": "map",
+          "entry_schema": {
+            "type": "string"
+          }
+        },
+        "key-dependencies": {
+          "required": true,
+          "type": "list",
+          "entry_schema": {
+            "type": "string"
+          }
+        }
+      },
+      "derived_from": "tosca.nodes.ResourceSource"
+   }

diff --git a/docs/datadictionary/sourcecapabilitycode.rst b/docs/datadictionary/sourcecapabilitycode.rst
index 145bab7..d2f66c7 100644 (file)
--- a/docs/datadictionary/sourcecapabilitycode.rst
+++ b/docs/datadictionary/sourcecapabilitycode.rst
@@ -8,35 +8,37 @@ Source Capability Code
 .. code-block:: json
    :linenos:
 
-   "description": "This is Component Resource Source Node Type",
-   "version": "1.0.0",
-   "properties": {
-     "script-type": {
-       "required": true,
-       "type": "string",
-       "default": "kotlin",
-       "constraints": [
-         {
-           "valid_values": [
-             "kotlin",
-             "jython"
-           ]
-         }
-       ]
-     },
-     "script-class-reference": {
-       "description": "Capability reference name for internal and kotlin, for jython script file path",
-       "required": true,
-       "type": "string"
-     },
-      "key-dependencies": {
-       "description": "Resource Resolution dependency dictionary names.",
-       "required": true,
-       "type": "list",
-       "entry_schema": {
-         "type": "string"
-       }
-     }
-   },
-   "derived_from": "tosca.nodes.ResourceSource"
+   {
+      "description": "This is Component Resource Source Node Type",
+      "version": "1.0.0",
+      "properties": {
+        "script-type": {
+          "required": true,
+          "type": "string",
+          "default": "kotlin",
+          "constraints": [
+            {
+              "valid_values": [
+                "kotlin",
+                "jython"
+              ]
+            }
+          ]
+        },
+        "script-class-reference": {
+          "description": "Capability reference name for internal and kotlin, for jython script file path",
+          "required": true,
+          "type": "string"
+        },
+         "key-dependencies": {
+          "description": "Resource Resolution dependency dictionary names.",
+          "required": true,
+          "type": "list",
+          "entry_schema": {
+            "type": "string"
+          }
+        }
+      },
+      "derived_from": "tosca.nodes.ResourceSource"
+   }
 

diff --git a/docs/datadictionary/sourcedefaultcode.rst b/docs/datadictionary/sourcedefaultcode.rst
index 89c5c2c..41c1933 100644 (file)
--- a/docs/datadictionary/sourcedefaultcode.rst
+++ b/docs/datadictionary/sourcedefaultcode.rst
@@ -8,7 +8,9 @@ Source Default code
 .. code-block:: json
    :linenos:
 
-   "description": "This is Default Resource Source Node Type",
-   "version": "1.0.0",
-   "properties": {},
-   "derived_from": "tosca.nodes.ResourceSource"
+   {
+      "description": "This is Default Resource Source Node Type",
+      "version": "1.0.0",
+      "properties": {},
+      "derived_from": "tosca.nodes.ResourceSource"
+   }

diff --git a/docs/datadictionary/sourceinputcode.rst b/docs/datadictionary/sourceinputcode.rst
index c400a8c..a70ff6a 100644 (file)
--- a/docs/datadictionary/sourceinputcode.rst
+++ b/docs/datadictionary/sourceinputcode.rst
@@ -8,7 +8,9 @@ Source Input code
 .. code-block:: json
    :linenos:
    
-   "description": "This is Input Resource Source Node Type",
-   "version": "1.0.0",
-   "properties": {},
-   "derived_from": "tosca.nodes.ResourceSource"
+   {
+      "description": "This is Input Resource Source Node Type",
+      "version": "1.0.0",
+      "properties": {},
+      "derived_from": "tosca.nodes.ResourceSource"
+   }

diff --git a/docs/datadictionary/sourceprimarydbcode.rst b/docs/datadictionary/sourceprimarydbcode.rst
index 949dee0..2243e0c 100644 (file)
--- a/docs/datadictionary/sourceprimarydbcode.rst
+++ b/docs/datadictionary/sourceprimarydbcode.rst
@@ -8,48 +8,50 @@ Source Primary DB Code:
 .. code-block:: json
    :linenos:
 
-   "description": "This is Database Resource Source Node Type",
-   "version": "1.0.0",
-   "properties": {
-     "type": {
-       "required": true,
-       "type": "string",
-       "constraints": [
-         {
-           "valid_values": [
-             "SQL"
-           ]
-         }
-       ]
-     },
-     "endpoint-selector": {
-       "required": false,
-       "type": "string"
-     },
-     "query": {
-       "required": true,
-       "type": "string"
-     },
-     "input-key-mapping": {
-       "required": false,
-       "type": "map",
-       "entry_schema": {
-         "type": "string"
-       }
-     },
-     "output-key-mapping": {
-       "required": false,
-       "type": "map",
-       "entry_schema": {
-         "type": "string"
-       }
-     },
-     "key-dependencies": {
-       "required": true,
-       "type": "list",
-       "entry_schema": {
-         "type": "string"
-       }
-     }
-   },
-   "derived_from": "tosca.nodes.ResourceSource"
\ No newline at end of file
+   {
+      "description": "This is Database Resource Source Node Type",
+      "version": "1.0.0",
+      "properties": {
+        "type": {
+          "required": true,
+          "type": "string",
+          "constraints": [
+            {
+              "valid_values": [
+                "SQL"
+              ]
+            }
+          ]
+        },
+        "endpoint-selector": {
+          "required": false,
+          "type": "string"
+        },
+        "query": {
+          "required": true,
+          "type": "string"
+        },
+        "input-key-mapping": {
+          "required": false,
+          "type": "map",
+          "entry_schema": {
+            "type": "string"
+          }
+        },
+        "output-key-mapping": {
+          "required": false,
+          "type": "map",
+          "entry_schema": {
+            "type": "string"
+          }
+        },
+        "key-dependencies": {
+          "required": true,
+          "type": "list",
+          "entry_schema": {
+            "type": "string"
+          }
+        }
+      },
+      "derived_from": "tosca.nodes.ResourceSource"
+   }

diff --git a/docs/designtime.rst b/docs/designtime.rst
index ac0af51..250640b 100644 (file)
--- a/docs/designtime.rst
+++ b/docs/designtime.rst
@@ -40,7 +40,7 @@ While doing so, identify the resources using the same process to be resolved; fo
 
 
 Services:
---------
+---------
 
 .. toctree::
    :maxdepth: 1

diff --git a/docs/installation.rst b/docs/installation.rst
index ef51fa0..6d3f069 100644 (file)
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -44,7 +44,7 @@ helm install --name cds cds
 Result
 ------
 
-.. code-block:: json
+.. code-block:: bash
    :linenos:
    
    $ kubectl get all --selector=release=cds
@@ -85,4 +85,4 @@ Loopback Server:
 ~~~~~~~~~~~~~~~~
 
 npm install in the directory cds/cds-ui/server
-npm start should bring you the CDS UI page in your local machine with the link https://127.0.0.1:3000/
\ No newline at end of file
+npm start should bring you the CDS UI page in your local machine with the link https://127.0.0.1:3000/

diff --git a/docs/microservices/workflow.rst b/docs/microservices/workflow.rst
index b74a49d..b6ea1e6 100644 (file)
--- a/docs/microservices/workflow.rst
+++ b/docs/microservices/workflow.rst
@@ -31,43 +31,41 @@ Below the properties of a workflow:
 Workflow Example
 ----------------
 
-.. code:: json
-
-print("
-{
-  "workflow": {
-    "resource-assignment": {                                <- workflow-name
-      "inputs": {
-        "vnf-id": {                                         <- static inputs
-          "required": true,
-          "type": "string"
-        },
-        "resource-assignment-properties": {                    <- dynamic inputs
-          "required": true,
-          "type": "dt-resource-assignment-properties"
-        }
-      },
-      "steps": {
-        "call-resource-assignment": {                       <- step-name
-          "description": "Resource Assignment Workflow",
-          "target": "resource-assignment-process"           <- node_template targeted by the step
-        }
-      },
-      "outputs": {
-        "template-properties": {                            <- output
-          "type": "json",                                   <- complex type
-          "value": {
-            "get_attribute": [                              <- uses expression to retrieve attribute from context
-              "resource-assignment",
-              "assignment-params"
-            ]
-          }
-        }
-      }
-    }
-  }
-}
-")
-
-
-TOSCA definition: http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.2/csd01/TOSCA-Simple-Profile-YAML-v1.2-csd01.html#_Toc494454203
\ No newline at end of file
+::
+
+   {
+     "workflow": {
+       "resource-assignment": {                                <- workflow-name
+         "inputs": {
+           "vnf-id": {                                         <- static inputs
+             "required": true,
+             "type": "string"
+           },
+           "resource-assignment-properties": {                    <- dynamic inputs
+             "required": true,
+             "type": "dt-resource-assignment-properties"
+           }
+         },
+         "steps": {
+           "call-resource-assignment": {                       <- step-name
+             "description": "Resource Assignment Workflow",
+             "target": "resource-assignment-process"           <- node_template targeted by the step
+           }
+         },
+         "outputs": {
+           "template-properties": {                            <- output
+             "type": "json",                                   <- complex type
+             "value": {
+               "get_attribute": [                              <- uses expression to retrieve attribute from context
+                 "resource-assignment",
+                 "assignment-params"
+               ]
+             }
+           }
+         }
+       }
+     }
+   }
+
+
+TOSCA definition: http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.2/csd01/TOSCA-Simple-Profile-YAML-v1.2-csd01.html#_Toc494454203