Merge "adding the basic running steps for CDS in README file"

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

diff --git a/docs/datadictionary/index.rst b/docs/datadictionary/index.rst
index 2405000..4039cca 100644 (file)
--- a/docs/datadictionary/index.rst
+++ b/docs/datadictionary/index.rst
@@ -13,30 +13,22 @@ A Resource definition models the how a specific resource can be resolved.
 
 A resource is a variable/parameter in the context of the service. It can be anything, but it should not be confused with SDC or Openstack resources.
 
-A Resource definition can have multiple sources to handle resolution in different ways.
-
-The main goal of Resource definition is to define re-usable entity that could be shared.
-
-Creation of data dictionaries is a standalone activity, separated from the blueprint design.
+A Resource definition can have multiple sources to handle resolution in different ways. The main goal of Resource definition is to define re-usable entity that could be shared.
 
+Creation of Resource definition is a standalone activity, separated from the blueprint design.
 
 As part of modelling a Resource definition entry, the following generic information should be provided:
 
 |image0|
 
-.. |image0| image:: image0.jpg
-   :width: 7.88889in 
-   :height: 4.43750in
 
-Bellow are properties that all the resource source have will have
+
+Below are properties that all the resource source have will have
 
 The modeling does allow for data translation between external capability and CDS for both input and output key mapping.
 
 |image1|
 
-.. |image1| image:: image1.jpg
-   :width: 7.88889in 
-   :height: 4.43750in
 
 Example:
 ========
@@ -45,33 +37,10 @@ vf-module-model-customization-uuid and vf-module-label are two data dictionaries
 
 Here is how input-key-mapping, output-key-mapping and key-dependencies can be used:
 
-vf-module-label Resource definition  
-
-{
-  "name" : "vf-module-label",
-  "tags" : "vf-module-label",
-  "updated-by" : "adetalhouet",
-  "property" : {
-    "description" : "vf-module-label",
-    "type" : "string"
-  },
-  "sources" : {
-    "primary-db" : {
-      "type" : "source-primary-db",
-      "properties" : {
-        "type" : "SQL",
-        "query" : "select sdnctl.VF_MODULE_MODEL.vf_module_label as vf_module_label from sdnctl.VF_MODULE_MODEL where sdnctl.VF_MODULE_MODEL.customization_uuid=:customizationid",
-        "input-key-mapping" : {
-          "customizationid" : "vf-module-model-customization-uuid"
-        },
-        "output-key-mapping" : {
-          "vf-module-label" : "vf_module_label"
-        },
-        "key-dependencies" : [ "vf-module-model-customization-uuid" ]
-      }
-    }
-  }
-}
+.. toctree::
+   :maxdepth: 1
+   
+   resourcedefinitioncodesnip 
 
 
 Resource source:
@@ -81,7 +50,7 @@ Defines the contract to resolve a resource.
 
 A resource source is modeled, following TOSCA_ node type definition and derives from the Resource_ source.
 
-Also please click below for detailed resource source details
+Also please click below for resource source available details
 
 .. toctree::
    :maxdepth: 1
@@ -89,4 +58,13 @@ Also please click below for detailed resource source details
    resourcesource
 
 .. _TOSCA: http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.0/csprd01/TOSCA-Simple-Profile-YAML-v1.0-csprd01.html#DEFN_ENTITY_NODE_TYPE
-.. _Resource_: https://wiki.onap.org/display/DW/Modeling+Concepts#ModelingConcepts-NodeResourceSource
\ No newline at end of file
+.. _Resource: https://wiki.onap.org/display/DW/Modeling+Concepts#ModelingConcepts-NodeResourceSource
+
+
+.. |image0| image:: media/mandatory.JPG
+   :width: 7.88889in 
+   :height: 4.43750in
+   
+.. |image1| image:: media/optional.JPG
+   :width: 7.88889in 
+   :height: 4.43750in
\ No newline at end of file