summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLusheng Ji <lji@research.att.com>2017-10-13 17:56:38 +0000
committerLusheng Ji <lji@research.att.com>2017-10-13 17:56:47 +0000
commitf82a6c40fddab065f90030e1d3def9662ac50b9a (patch)
tree3035b4ebba3c68b38480af894e149d536e050ae2
parent30c453e3bfa40414c1c1951fef2b97dc52ee7dae (diff)
Add blueprint doc example
Issue-Id: DCAEGEN2-128 Change-Id: I214e0f560050a49affb378ca08f3f6100623eaec Signed-off-by: Lusheng Ji <lji@research.att.com>
-rw-r--r--docs/sections/blueprints/example.rst19
-rw-r--r--docs/sections/configuration.rst22
2 files changed, 24 insertions, 17 deletions
diff --git a/docs/sections/blueprints/example.rst b/docs/sections/blueprints/example.rst
new file mode 100644
index 00000000..47e52fdb
--- /dev/null
+++ b/docs/sections/blueprints/example.rst
@@ -0,0 +1,19 @@
+= My BluePrint Name
+
+Overview of my blueprint and the part it plays in DCAE.
+
+== Blue print files
+
+List where we can find the blueprints
+
+== Parameters
+
+The input parameters needed for running the blueprint
+
+== How to run
+
+Cfy command for running the blueprint
+
+== Addiional information
+
+Any additional information that help other people understanding and using yor blueprint
diff --git a/docs/sections/configuration.rst b/docs/sections/configuration.rst
index 085f9c66..733e0bc9 100644
--- a/docs/sections/configuration.rst
+++ b/docs/sections/configuration.rst
@@ -4,24 +4,12 @@
Configuration
=============
-.. note::
- * This section is used to describe the options a software component offers for configuration.
+DACEGEN2 platform deploys its components via Cloudify Blueprints. Below is the list of Blueprints included in ONAP DCAEGEN2
+and details for how to configure them.
- * Configuration is typically: provided for platform-component and sdk projects;
- and referenced in developer and user guides.
-
- * This note must be removed after content has been added.
+.. toctree::
+ :maxdepth: 1
+ ./blueprints/PGaaS.rst
-Example ...
-
-You can provide the following in ``basic.conf``
-
-``host=ADDRESS``
- The address of the host
-
-``port=PORT``
- The port used for signaling
-
- Optional. Default: ``8080``