[RICPLT-2523] Add SelectE2TInstance mechanism | Change Setup flow | Refactor code...
[ric-plt/e2mgr.git] / docs / release-notes.rst
1 .. 
2 ..  Copyright (c) 2019 AT&T Intellectual Property.
3 ..  Copyright (c) 2019 Nokia.
4 ..
5 ..  Licensed under the Creative Commons Attribution 4.0 International
6 ..  Public License (the "License"); you may not use this file except
7 ..  in compliance with the License. You may obtain a copy of the License at
8 ..
9 ..    https://creativecommons.org/licenses/by/4.0/
10 ..
11 ..  Unless required by applicable law or agreed to in writing, documentation
12 ..  distributed under the License is distributed on an "AS IS" BASIS,
13 ..  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 ..
15 ..  See the License for the specific language governing permissions and
16 ..  limitations under the License.
17 ..
18
19
20
21 This document provides the release notes for <RELEASE> of <COMPONENT>.
22
23 .. contents::
24    :depth: 3
25    :local:
26
27
28 Version history
29 ---------------
30
31 +--------------------+--------------------+--------------------+--------------------+
32 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
33 |                    |                    |                    |                    |
34 +--------------------+--------------------+--------------------+--------------------+
35 | 20XX-XX-XX         | 0.1.0              |                    | First draft        |
36 |                    |                    |                    |                    |
37 +--------------------+--------------------+--------------------+--------------------+
38 |                    | 0.1.1              |                    |                    |
39 |                    |                    |                    |                    |
40 +--------------------+--------------------+--------------------+--------------------+
41 |                    | 1.0                |                    |                    |
42 |                    |                    |                    |                    |
43 +--------------------+--------------------+--------------------+--------------------+
44
45
46 Summary
47 =======
48
49 <SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
50
51
52
53
54 Release Data
55 ============
56 <STATE RELEVANT RELEASE DATA/RECORDS>
57
58 <EXAMPLE>:
59
60 +--------------------------------------+--------------------------------------+
61 | **Project**                          | E.g. Arno/genesis/fuel@opnfv         |
62 |                                      |                                      |
63 +--------------------------------------+--------------------------------------+
64 | **Repo/commit-ID**                   | E.g. genesis/adf634a0d4.....         |
65 |                                      |                                      |
66 +--------------------------------------+--------------------------------------+
67 | **Release designation**              | E.g. Arno RC2                        |
68 |                                      |                                      |
69 +--------------------------------------+--------------------------------------+
70 | **Release date**                     | E.g. 2015-04-16                      |
71 |                                      |                                      |
72 +--------------------------------------+--------------------------------------+
73 | **Purpose of the delivery**          | E.g. OPNFV Internal quality assurance|
74 |                                      |                                      |
75 +--------------------------------------+--------------------------------------+
76
77
78
79
80 Feature additions
81 ~~~~~~~~~~~~~~~~~~~~~~~
82 <STATE ADDED FEATURES BY REFERENCE TO JIRA>
83
84 <EXAMPLE>:
85
86 **JIRA BACK-LOG:**
87
88 +--------------------------------------+--------------------------------------+
89 | **JIRA REFERENCE**                   | **SLOGAN**                           |
90 |                                      |                                      |
91 +--------------------------------------+--------------------------------------+
92 |                                      |                                      |
93 |                                      |                                      |
94 |                                      |                                      |
95 +--------------------------------------+--------------------------------------+
96 |                                      |                                      |
97 |                                      |                                      |
98 |                                      |                                      |
99 +--------------------------------------+--------------------------------------+
100
101 Bug corrections
102 ~~~~~~~~~~~~~~~~~~~~~
103
104 **JIRA TICKETS:**
105
106 +--------------------------------------+--------------------------------------+
107 | **JIRA REFERENCE**                   | **SLOGAN**                           |
108 |                                      |                                      |
109 +--------------------------------------+--------------------------------------+
110 |                                      |                                      |
111 |                                      |                                      |
112 |                                      |                                      |
113 +--------------------------------------+--------------------------------------+
114 |                                      |                                      |
115 |                                      |                                      |
116 |                                      |                                      |
117 +--------------------------------------+--------------------------------------+
118
119 Deliverables
120 ----------------
121
122 Software deliverables
123 ^^^^^^^^^^^^^^^^^^^^^^^
124
125 <STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
126
127 <EXAMPLE>:
128
129 Documentation deliverables
130 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
131
132 <STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
133
134 <EXAMPLE>:
135
136
137 Known Limitations, Issues and Workarounds
138 =========================================
139
140 System Limitations
141 ^^^^^^^^^^^^^^^^^^^^
142 <STATE ALL RELEVANT SYSTEM LIMITATIONS, IF THERE IS ANY>
143
144
145
146 Known issues
147 ^^^^^^^^^^^^^^^
148 <STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
149
150 <EXAMPLE>:
151
152 **JIRA TICKETS:**
153
154 +--------------------------------------+--------------------------------------+
155 | **JIRA REFERENCE**                   | **SLOGAN**                           |
156 |                                      |                                      |
157 +--------------------------------------+--------------------------------------+
158 |                                      |                                      |
159 |                                      |                                      |
160 |                                      |                                      |
161 +--------------------------------------+--------------------------------------+
162 |                                      |                                      |
163 |                                      |                                      |
164 |                                      |                                      |
165 +--------------------------------------+--------------------------------------+
166
167 Workarounds
168 ^^^^^^^^^^^^^^^^^
169
170 <STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE, IF THERE IS ANY>
171
172
173
174
175 References
176 ==========
177 <STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
178
179
180
181