Enhancement and additions for webinar

Add templates, revise master index, guides, and release document
Improve project integration instructions based on 5 project
integrations.

Change-Id: I2a3e62737f3c126b7f5fb7cc4f53b35dba4f1d8f
Issue-ID: DOC-26
Signed-off-by: Rich Bennett <rb2745@att.com>

9 files changed, 155 insertions, 0 deletions

diff --git a/docs/templates/platform-component/administration.rst b/docs/templates/platform-component/administration.rst
new file mode 100644
index 000000000..1d512cf02
--- /dev/null
+++ b/docs/templates/platform-component/administration.rst
@@ -0,0 +1,19 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+Administration
+--------------
+Describe expected changes and the processes and actions taken for each.
+
+
+Processes
++++++++++
+* Process 1
+* Process 2
+
+Actions
++++++++
+* Action X
+* Action Y
+
diff --git a/docs/templates/platform-component/configuration.rst b/docs/templates/platform-component/configuration.rst
new file mode 100644
index 000000000..c0c969f85
--- /dev/null
+++ b/docs/templates/platform-component/configuration.rst
@@ -0,0 +1,19 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Configuration
+-------------
+Describe configurations how to provide parameters and value
+
+Basic Setup
++++++++++++
+
+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``
diff --git a/docs/templates/platform-component/consumedapis.rst b/docs/templates/platform-component/consumedapis.rst
new file mode 100644
index 000000000..c4309cdb1
--- /dev/null
+++ b/docs/templates/platform-component/consumedapis.rst
@@ -0,0 +1,8 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Consumed APIs
+=============
+References to APIs offered by other components
+
+
diff --git a/docs/templates/platform-component/delivery.rst b/docs/templates/platform-component/delivery.rst
new file mode 100644
index 000000000..cfcab0449
--- /dev/null
+++ b/docs/templates/platform-component/delivery.rst
@@ -0,0 +1,31 @@
+Delivery
+--------
+Describe how functions are packaged into run-time components.
+For some components a block diagram may be useful.
+
+.. blockdiag::
+   
+
+   blockdiag layers {
+   orientation = portrait
+   a -> m;
+   b -> n;
+   c -> x;
+   m -> y;
+   m -> z;
+   group l1 {
+	color = blue;
+	x; y; z;
+	}
+   group l2 {
+	color = yellow;
+	m; n; 
+	}
+   group l3 {
+	color = orange;
+	a; b; c;
+	}
+
+   }
+
+
diff --git a/docs/templates/platform-component/humaninterfaces.rst b/docs/templates/platform-component/humaninterfaces.rst
new file mode 100644
index 000000000..03cc875ed
--- /dev/null
+++ b/docs/templates/platform-component/humaninterfaces.rst
@@ -0,0 +1,19 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Human Interfaces
+----------------
+Provide info on the targeted user, interface types, ports/protocols to access, etc.
+
+Target Users
+++++++++++++
+
+Interface Type
+++++++++++++++
+
+Access
+++++++
+
+
+
+
diff --git a/docs/templates/platform-component/index.rst b/docs/templates/platform-component/index.rst
new file mode 100644
index 000000000..4364739ee
--- /dev/null
+++ b/docs/templates/platform-component/index.rst
@@ -0,0 +1,19 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Platform Component
+==================
+Provide an overview of the ONAP Platform component capabilities here.
+Add or remove sections below as appropriate for the platform component.
+
+.. toctree::
+   :maxdepth: 2
+
+   delivery.rst
+   offeredapis.rst
+   consumedapis.rst
+   logging.rst
+   installation.rst
+   configuration.rst
+   administration.rst
+   humaninterfaces.rst
diff --git a/docs/templates/platform-component/installation.rst b/docs/templates/platform-component/installation.rst
new file mode 100644
index 000000000..3238236c4
--- /dev/null
+++ b/docs/templates/platform-component/installation.rst
@@ -0,0 +1,14 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Installation
+------------
+Describe the environment and steps to install.
+
+
+Environment
++++++++++++
+
+
+Steps
++++++
diff --git a/docs/templates/platform-component/logging.rst b/docs/templates/platform-component/logging.rst
new file mode 100644
index 000000000..8d480e283
--- /dev/null
+++ b/docs/templates/platform-component/logging.rst
@@ -0,0 +1,14 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Logging & Diagnostic Information
+--------------------------------
+Description of how to interact with and diagnose problems with the components
+as delivered.
+
+Where to Access Information
++++++++++++++++++++++++++++
+
+
+Error / Warning Messages
+++++++++++++++++++++++++
diff --git a/docs/templates/platform-component/offeredapis.rst b/docs/templates/platform-component/offeredapis.rst
new file mode 100644
index 000000000..3e3b5b3d0
--- /dev/null
+++ b/docs/templates/platform-component/offeredapis.rst
@@ -0,0 +1,12 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+Offered APIs
+============
+List APIs offered.   One or more of the following examples may be appropriate.
+
+* java docs link
+* rest API swagger json definition displayed with sphinx directive .. swaggerv2doc:
+* a restructured text document
+