Adding documentation to repo
[ric-plt/ric-dep.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. ===============LICENSE_START=======================================================
4 .. Copyright (C) 2019 AT&T Intellectual Property      
5 .. ===================================================================================
6 .. This documentation file is distributed under the Creative Commons Attribution 
7 .. 4.0 International License (the "License"); you may not use this file except in 
8 .. compliance with the License.  You may obtain a copy of the License at
9 ..
10 .. http://creativecommons.org/licenses/by/4.0
11 ..
12 .. This file is distributed on an "AS IS" BASIS,
13 .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 .. See the License for the specific language governing permissions and
15 .. limitations under the License.
16 .. ===============LICENSE_END=========================================================
17
18
19 This document provides the release notes for <RELEASE> of <COMPONENT>.
20
21 .. contents::
22    :depth: 3
23    :local:
24
25
26 Release Notes
27 =============
28
29 Version history
30 ---------------
31
32 +--------------------+--------------------+--------------------+--------------------+
33 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
34 |                    |                    |                    |                    |
35 +--------------------+--------------------+--------------------+--------------------+
36 | 2020-02-20         | 0.1.0              | Abdul Wahid W      | First draft        |
37 |                    |                    |                    |                    |
38 +--------------------+--------------------+--------------------+--------------------+
39
40
41 Summary
42 -------
43
44 The ric-plt/dep repositoy hosts deployment and integration artifacts such as scripts, Helm charts, and other files used for deploying RIC   Platform Software.
45
46 For release this repo contains:
47
48 - Deployment scripts and Helm charts for Near Realtime RAN Intelligent Controller Platform.
49
50
51 Release Data
52 ------------
53
54 +--------------------------------------+--------------------------------------+
55 | **Project**                          | Integration and Testing              |
56 |                                      |                                      |
57 +--------------------------------------+--------------------------------------+
58 | **Repo/commit-ID**                   | ric-plt/dep                          |
59 |                                      |                                      |
60 +--------------------------------------+--------------------------------------+
61 | **Release designation**              | Bronze                               |
62 |                                      |                                      |
63 +--------------------------------------+--------------------------------------+
64 | **Release date**                     | 2020-02-29                           |
65 |                                      |                                      |
66 +--------------------------------------+--------------------------------------+
67 | **Purpose of the delivery**          | First release                        |
68 |                                      |                                      |
69 +--------------------------------------+--------------------------------------+
70
71
72
73
74 Feature additions
75 -------------------
76
77 **JIRA BACK-LOG:**
78
79 +--------------------------------------+--------------------------------------+
80 | **JIRA REFERENCE**                   | **SLOGAN**                           |
81 |                                      |                                      |
82 +--------------------------------------+--------------------------------------+
83 |                                      |                                      |
84 |                                      |                                      |
85 |                                      |                                      |
86 +--------------------------------------+--------------------------------------+
87 |                                      |                                      |
88 |                                      |                                      |
89 |                                      |                                      |
90 +--------------------------------------+--------------------------------------+
91
92 Bug corrections
93 ----------------
94
95 **JIRA TICKETS:**
96
97 +--------------------------------------+--------------------------------------+
98 | **JIRA REFERENCE**                   | **SLOGAN**                           |
99 |                                      |                                      |
100 +--------------------------------------+--------------------------------------+
101 |                                      |                                      |
102 |                                      |                                      |
103 |                                      |                                      |
104 +--------------------------------------+--------------------------------------+
105 |                                      |                                      |
106 |                                      |                                      |
107 |                                      |                                      |
108 +--------------------------------------+--------------------------------------+
109
110 Deliverables
111 -------------
112
113
114
115 Software deliverables
116 ---------------------
117
118
119
120 Documentation deliverables
121 ---------------------------
122
123 Documentation for installing, using, and developing for Integration and Testing project can be found at: 
124
125 ::
126
127 %  https://o-ran-sc-doc.readthedocs.io/projects/o-ran-sc-ric-plt-dep/en/latest/index.html
128
129 Known Limitations, Issues, and Workarounds
130 ------------------------------------------
131
132 System Limitations
133 ------------------
134
135
136 Known issues
137 ------------------
138
139 **JIRA TICKETS:**
140
141 +--------------------------------------+--------------------------------------+
142 | **JIRA REFERENCE**                   | **SLOGAN**                           |
143 |                                      |                                      |
144 +--------------------------------------+--------------------------------------+
145 |                                      |                                      |
146 |                                      |                                      |
147 |                                      |                                      |
148 +--------------------------------------+--------------------------------------+
149 |                                      |                                      |
150 |                                      |                                      |
151 |                                      |                                      |
152 +--------------------------------------+--------------------------------------+
153
154 Workarounds
155 ------------------
156
157
158
159
160 References
161 -----------
162
163
164
165