Fix index and add templates 71/20871/1
authorRich Bennett <rb2745@att.com>
Thu, 26 Oct 2017 21:41:13 +0000 (17:41 -0400)
committerRich Bennett <rb2745@att.com>
Thu, 26 Oct 2017 21:45:30 +0000 (17:45 -0400)
Added index title
Added architecture and release note templates

Change-Id: I194761c176c982a3fe4b2ec877055ebd3b8e60a1
Issue-ID: DOC-130
Signed-off-by: Rich Bennett <rb2745@att.com>
docs/architecture.rst [new file with mode: 0644]
docs/index.rst
docs/release-notes.rst [new file with mode: 0644]

diff --git a/docs/architecture.rst b/docs/architecture.rst
new file mode 100644 (file)
index 0000000..6f677d1
--- /dev/null
@@ -0,0 +1,20 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
+
+
+CCSDK Plugin Architecture
+=========================
+CCSDK Plugins extend the capabilities of the orchestrator to integrate with other components
+
+
+Capabilities
+------------
+
+
+Usage Scenarios
+---------------
+
+
+Interactions
+------------
index 3597838..5fb384b 100644 (file)
@@ -1,8 +1,15 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
+
+CCSDK Platform Plugins
+======================
+
 
 .. toctree::
    :maxdepth: 1
 
+   architecture.rst
    dmaap.rst
    dnsdesig.rst
    pgaas.rst
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644 (file)
index 0000000..b568bee
--- /dev/null
@@ -0,0 +1,48 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Release Notes
+=============
+
+.. note::
+       * This Release Notes must be updated each time the team decides to Release new artifacts.
+       * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes.
+       * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes.
+       * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release.
+       * This note must be removed after content has been added.
+
+
+Version: x.y.z
+--------------
+
+
+:Release Date: yyyy-mm-dd
+
+
+
+**New Features**
+
+One or two sentences explaining the purpose of this Release.
+
+**Bug Fixes**
+       - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing.
+**Known Issues**
+       - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two, three sentences.
+         One sentences explaining what is the issue.
+         
+         Another sentence explaining the impact of the issue.
+         
+         And an optional sentence providing a workaround.
+
+**Security Issues**
+       You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_
+
+
+**Upgrade Notes**
+
+**Deprecation Notes**
+
+**Other**
+
+===========
+
+End of Release Notes