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