Added Docs and Readme.md

[ric-app/hw-python.git] / docs / release-notes.rst

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644 (file)
index 0000000..2525290
--- /dev/null
+++ b/docs/release-notes.rst
@@ -0,0 +1,85 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved.Copyright (C) 2020
+
+
+Release Notes
+=============
+
+
+This document provides the release notes for the Bronze Release of the HelloWorld (HW) xAPP.
+
+.. contents::
+   :depth: 3
+   :local:
+
+
+Version history
+---------------
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| -                  | -                  |   Rahul Banerji    | -                  |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+
+
+
+Summary
+-------
+
+This release of the Python HW xAPP demonstrates the following:
+
+-E2, A1 interfaces interactions.
+
+-Read-write operations into a persistent storage.
+
+-xAPP Configuration management
+
+-RMR Health Check
+
+-xAPP Health Check
+
+-Raising alarms
+
+-Generating metrics
+
+
+Release Data
+------------
+
++--------------------------------------+--------------------------------------+
+| **Project**                          | RAN Intelligent Controller           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Repo/commit-ID**                   |      TBD                             |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release designation**              |      TBD                             |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     |      TBD                             |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery**          | open-source Python Hello World xAPP  |
+|                                      |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+Components
+----------
+
+TBD
+
+  
+    
+
+Limitations
+-----------
+- The HW xAPP doesn't have any usecase in particular to display SDL capabilities.
+
+- The subscription process assumes, on sending subscription request results in valid subscription response. 
+
+- The HW xAPP doesn't address any RIC usecase in particular.