Align architecture release note document sections

Align sections with aggregate architecture and release note sections
Convert release note template to the newer single file form
Add .gitreview file

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

diff --git a/.gitreview b/.gitreview
new file mode 100644 (file)
index 0000000..98dc34e
--- /dev/null
+++ b/.gitreview
@@ -0,0 +1,4 @@
+[gerrit]
+host=gerrit.onap.org
+port=29418
+project=msb/apigateway.git

diff --git a/docs/index.rst b/docs/index.rst
index 453e146..a55f4dd 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -12,5 +12,5 @@ This document is aimed to give the users some brief introductions on MSB from di
    :maxdepth: 1
    
    platform/index.rst
-   release-notes/index.rst
+   release-notes.rst
 

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644 (file)
index 0000000..40e263a
--- /dev/null
+++ b/docs/release-notes.rst
@@ -0,0 +1,52 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+MSB API Gateway 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.
+
+Microservices Bus provide key infrastructure functionalities to support ONAP microservice architecture including service registration/discovery, service gateway, service load balancer and service governance. It's a pluggable architecture so it can be extended with plugins to provide value added services such as centralized authentication for APIs. Microservices Platform also provides a GUI portal for service management.
+
+
+
+Version: x.y.z
+--------------
+
+
+:Release Date: yyyy-mm-dd
+
+
+
+**New Features**
+
+ - Service Registration–RESTFul API
+ - Service Registration-OOM Registrator
+ - Service Registration-MSB SDK
+ - Service Registration-MSB GUI
+ - Service Discovery-API Gateway
+ - Service Discovery-MSB SDK
+
+**Bug Fixes**
+
+
+**Known Issues**
+
+**Security Issues**
+
+
+**Upgrade Notes**
+
+**Deprecation Notes**
+
+**Other**
+
+===========
+
+End of Release Notes

diff --git a/docs/release-notes/bug-fixes.rst b/docs/release-notes/bug-fixes.rst
deleted file mode 100644 (file)
index 4dc09fc..0000000
--- a/docs/release-notes/bug-fixes.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-Bug Fixes
----------

diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst
deleted file mode 100644 (file)
index 19f0bff..0000000
--- a/docs/release-notes/index.rst
+++ /dev/null
@@ -1,15 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-Release-notes
--------------
-
-Microservices Bus provide key infrastructure functionalities to support ONAP microservice architecture including service registration/discovery, service gateway, service load balancer and service governance. It's a pluggable architecture so it can be extended with plugins to provide value added services such as centralized authentication for APIs. Microservices Platform also provides a GUI portal for service management.
-
-.. toctree::
-   :maxdepth: 1
-   
-   new-features.rst
-   bug-fixes.rst
-   upgrade-notes.rst
-   security-issues.rst
-   known-issues.rst

diff --git a/docs/release-notes/known-issues.rst b/docs/release-notes/known-issues.rst
deleted file mode 100644 (file)
index f4341d7..0000000
--- a/docs/release-notes/known-issues.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-Known Issues
-------------

diff --git a/docs/release-notes/new-features.rst b/docs/release-notes/new-features.rst
deleted file mode 100644 (file)
index 2bddf16..0000000
--- a/docs/release-notes/new-features.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-New Features
-------------
- - Service Registration–RESTFul API
- - Service Registration-OOM Registrator
- - Service Registration-MSB SDK
- - Service Registration-MSB GUI
- - Service Discovery-API Gateway
- - Service Discovery-MSB SDK

diff --git a/docs/release-notes/security-issues.rst b/docs/release-notes/security-issues.rst
deleted file mode 100644 (file)
index 3a6cd9e..0000000
--- a/docs/release-notes/security-issues.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-Security Issues
----------------

diff --git a/docs/release-notes/upgrade-notes.rst b/docs/release-notes/upgrade-notes.rst
deleted file mode 100644 (file)
index 29e67e5..0000000
--- a/docs/release-notes/upgrade-notes.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-Upgrade Notes
--------------