Adding documentation to repo
[ric-plt/ric-dep.git] / docs / release-notes.rst
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644 (file)
index 0000000..1c01f64
--- /dev/null
@@ -0,0 +1,165 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. ===============LICENSE_START=======================================================
+.. Copyright (C) 2019 AT&T Intellectual Property      
+.. ===================================================================================
+.. This documentation file is distributed under the Creative Commons Attribution 
+.. 4.0 International License (the "License"); you may not use this file except in 
+.. compliance with the License.  You may obtain a copy of the License at
+..
+.. http://creativecommons.org/licenses/by/4.0
+..
+.. This file is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+.. ===============LICENSE_END=========================================================
+
+
+This document provides the release notes for <RELEASE> of <COMPONENT>.
+
+.. contents::
+   :depth: 3
+   :local:
+
+
+Release Notes
+=============
+
+Version history
+---------------
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2020-02-20         | 0.1.0              | Abdul Wahid W      | First draft        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+
+
+Summary
+-------
+
+The ric-plt/dep repositoy hosts deployment and integration artifacts such as scripts, Helm charts, and other files used for deploying RIC   Platform Software.
+
+For release this repo contains:
+
+- Deployment scripts and Helm charts for Near Realtime RAN Intelligent Controller Platform.
+
+
+Release Data
+------------
+
++--------------------------------------+--------------------------------------+
+| **Project**                          | Integration and Testing              |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Repo/commit-ID**                   | ric-plt/dep                          |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | Bronze                               |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | 2020-02-29                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery**          | First release                        |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+
+
+
+Feature additions
+-------------------
+
+**JIRA BACK-LOG:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE**                   | **SLOGAN**                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+|                                      |                                      |
+|                                      |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+|                                      |                                      |
+|                                      |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+Bug corrections
+----------------
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE**                   | **SLOGAN**                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+|                                      |                                      |
+|                                      |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+|                                      |                                      |
+|                                      |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+Deliverables
+-------------
+
+
+
+Software deliverables
+---------------------
+
+
+
+Documentation deliverables
+---------------------------
+
+Documentation for installing, using, and developing for Integration and Testing project can be found at: 
+
+::
+
+%  https://o-ran-sc-doc.readthedocs.io/projects/o-ran-sc-ric-plt-dep/en/latest/index.html
+
+Known Limitations, Issues, and Workarounds
+------------------------------------------
+
+System Limitations
+------------------
+
+
+Known issues
+------------------
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE**                   | **SLOGAN**                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+|                                      |                                      |
+|                                      |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+|                                      |                                      |
+|                                      |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+Workarounds
+------------------
+
+
+
+
+References
+-----------
+
+
+
+