Configure Repo for Documentation
[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 E2 Manager Release Notes 
22 ========================  
23 The following is a list of release highlights for E2 Manager:
24
25
26 2019 October 31; version 2.0.7 
27 ------------------------------ 
28 The following flows are supported:
29 - ENDC Setup
30 - X2 Setup
31 - ENDC Configuration Update
32 - X2 Configuration Update
33 - Reset
34 - Shutdown
35 - Load Information
36
37
38
39
40 Version history
41 ---------------
42
43 +--------------------+--------------------+--------------------+--------------------+
44 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
45 |                    |                    |                    |                    |
46 +--------------------+--------------------+--------------------+--------------------+
47 | 20XX-XX-XX         | 0.1.0              |                    | First draft        |
48 |                    |                    |                    |                    |
49 +--------------------+--------------------+--------------------+--------------------+
50 |                    | 0.1.1              |                    |                    |
51 |                    |                    |                    |                    |
52 +--------------------+--------------------+--------------------+--------------------+
53 |                    | 1.0                |                    |                    |
54 |                    |                    |                    |                    |
55 +--------------------+--------------------+--------------------+--------------------+
56
57
58 Summary
59 =======
60
61 <SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
62
63
64
65
66 Release Data
67 ============
68 <STATE RELEVANT RELEASE DATA/RECORDS>
69
70 <EXAMPLE>:
71
72 +--------------------------------------+--------------------------------------+
73 | **Project**                          | E.g. Arno/genesis/fuel@opnfv         |
74 |                                      |                                      |
75 +--------------------------------------+--------------------------------------+
76 | **Repo/commit-ID**                   | E.g. genesis/adf634a0d4.....         |
77 |                                      |                                      |
78 +--------------------------------------+--------------------------------------+
79 | **Release designation**              | E.g. Arno RC2                        |
80 |                                      |                                      |
81 +--------------------------------------+--------------------------------------+
82 | **Release date**                     | E.g. 2015-04-16                      |
83 |                                      |                                      |
84 +--------------------------------------+--------------------------------------+
85 | **Purpose of the delivery**          | E.g. OPNFV Internal quality assurance|
86 |                                      |                                      |
87 +--------------------------------------+--------------------------------------+
88
89
90
91
92 Feature additions
93 -----------------
94 <STATE ADDED FEATURES BY REFERENCE TO JIRA>
95
96 <EXAMPLE>:
97
98 **JIRA BACK-LOG:**
99
100 +--------------------------------------+--------------------------------------+
101 | **JIRA REFERENCE**                   | **SLOGAN**                           |
102 |                                      |                                      |
103 +--------------------------------------+--------------------------------------+
104 |                                      |                                      |
105 |                                      |                                      |
106 |                                      |                                      |
107 +--------------------------------------+--------------------------------------+
108 |                                      |                                      |
109 |                                      |                                      |
110 |                                      |                                      |
111 +--------------------------------------+--------------------------------------+
112
113 Bug corrections
114 ---------------
115
116 **JIRA TICKETS:**
117
118 +--------------------------------------+--------------------------------------+
119 | **JIRA REFERENCE**                   | **SLOGAN**                           |
120 |                                      |                                      |
121 +--------------------------------------+--------------------------------------+
122 |                                      |                                      |
123 |                                      |                                      |
124 |                                      |                                      |
125 +--------------------------------------+--------------------------------------+
126 |                                      |                                      |
127 |                                      |                                      |
128 |                                      |                                      |
129 +--------------------------------------+--------------------------------------+
130
131 Deliverables
132 ------------
133
134 Software deliverables
135 ---------------------
136
137 <STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
138
139 <EXAMPLE>:
140
141 Documentation deliverables
142 --------------------------
143
144 <STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
145
146 <EXAMPLE>:
147
148
149 Known Limitations, Issues and Workarounds
150 =========================================
151
152 System Limitations
153 ------------------
154 <STATE ALL RELEVANT SYSTEM LIMITATIONS, IF THERE IS ANY>
155
156
157
158 Known issues
159 ------------
160 <STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
161
162 <EXAMPLE>:
163
164 **JIRA TICKETS:**
165
166 +--------------------------------------+--------------------------------------+
167 | **JIRA REFERENCE**                   | **SLOGAN**                           |
168 |                                      |                                      |
169 +--------------------------------------+--------------------------------------+
170 |                                      |                                      |
171 |                                      |                                      |
172 |                                      |                                      |
173 +--------------------------------------+--------------------------------------+
174 |                                      |                                      |
175 |                                      |                                      |
176 |                                      |                                      |
177 +--------------------------------------+--------------------------------------+
178
179 Workarounds
180 -----------
181
182 <STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE, IF THERE IS ANY>
183
184
185
186
187 References
188 ==========
189 <STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
190
191
192
193