VNFRQTS - Adding release notes to hierarchy
[vnfrqts/requirements.git] / docs / release-notes.rst
1 .. Modifications Copyright © 2017-2018 AT&T Intellectual Property.
2
3 .. Licensed under the Creative Commons License, Attribution 4.0 Intl.
4    (the "License"); you may not use this documentation except in compliance
5    with the License. You may obtain a copy of the License at
6
7 .. https://creativecommons.org/licenses/by/4.0/
8
9 .. Unless required by applicable law or agreed to in writing, software
10    distributed under the License is distributed on an "AS IS" BASIS,
11    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12    See the License for the specific language governing permissions and
13    limitations under the License.
14
15 VNFRQTS Project Release Notes
16 ==============================
17
18 Version: 3.0.1
19 --------------
20
21 :Release Date: 2019-1-30
22
23 **New Features**
24     - No new features added during Casablanca Maintenance release
25
26 **Bug Fixes**
27     - Fixed typos
28     - Fixed metadata errors
29
30 **Known Issues**
31     - Links that refer to "latest" version are static.  Please report
32       any broken links.
33
34 **Security Issues**
35     - None
36
37 **Upgrade Notes**
38     - If you would like to add requirements, you **MUST** follow
39       `instructions on Wiki <https://wiki.onap.org/display/DW/VNFRQTS+How+to+Contribute>`__.
40
41 **Deprecation Notes**
42     - None
43
44 **Other**
45     - None
46
47
48 Version: 3.0.0
49 --------------
50
51 :Release Date: 2018-11-30
52
53 A detailed summary of all requirement changes per section can be found
54 :doc:`here <changes-by-section-casablanca>`.
55
56 A higher level summary of changes as well as non-requirement impacting
57 changes can be found below.
58
59 **New Features**
60     - Updated the Security requirements in Chapter 4 (Added, Removed, Reworded,
61       or Moved)
62     - Created new cybersecurity section in Chapter 4
63     - Changed the theme of the documents
64     - Moved Requirements list from Chapter 8 to Chapter 9
65     - Added a downloadable, dynamic JSON of all requirements, separated by
66       versions.  This is available on the Requirements List page.
67     - Updated the hierarchy and moved the VNF Requirements to a higher level in
68       the doc project
69     - Updated and created new wiki material on how to contribute
70     - Created enumerated requirements for TOSCA
71     - Updated Heat requirements
72     - Created new section for PNF Plug-and-Play with associated requirements
73     - Updated Management requirements
74     - Updated section for VES support
75     - Introduced new directive for requirements to use metadata
76     - Update test description annex
77
78 **Bug Fixes**
79     - Fixed typos
80     - Fixed broken links
81     - Fixing formatting in examples to print properly
82     - Fixed formatting of tables
83
84 **Known Issues**
85     - Links that refer to "latest" version are static.  Please report
86       any broken links.
87
88 **Security Issues**
89     - None
90
91 **Upgrade Notes**
92     - If you would like to add requirements, you **MUST** follow
93       `instructions on Wiki <https://wiki.onap.org/display/DW/VNFRQTS+How+to+Contribute>`__.
94
95 **Deprecation Notes**
96     - None
97
98 **Other**
99     - None
100
101 Version: 2.0.0
102 --------------
103
104 :Release Date: 2018-06-07 (Beijing Release)
105
106 **New Features**
107     - Chapter 5 Requirements changed from test to numbered requirements.
108
109         -https://jira.onap.org/browse/VNFRQTS-83
110
111     - Chapter Header re-structured to help readability of documents.
112
113         - https://jira.onap.org/browse/VNFRQTS-130
114         - https://wiki.onap.org/display/DW/VNF+Requirement+Updated+Header+Structure
115
116     - Changed language to take into consider PNF (xNF).
117
118         - https://jira.onap.org/browse/VNFRQTS-188
119         - https://jira.onap.org/browse/VNFRQTS-189
120
121     - Added copyright License Header in all source files
122
123         - https://jira.onap.org/browse/VNFRQTS-180
124
125 **Bug Fixes**
126     - Fixed Chapter Header Structure warnings.
127
128         - https://jira.onap.org/browse/VNFRQTS-193
129
130     - Found table in Chapter 8 section C.2 that was not printing,
131       corrected format.
132
133         - https://jira.onap.org/browse/VNFRQTS-192
134
135     - Fixes for language within requirements from clarification/grammar.
136
137         - The full list of changes made to requirements  is available on `JIRA <https://jira.onap.org/projects/VNFRQTS/issues>`_
138
139 **Known Issues**
140     - Need to review requirements that have bullet points as well as paragraphs to meet guidelines listed on `VNFRQTS <https://wiki.onap.org/display/DW/VNFRQTS+Requirement+Format+discussion>`_
141
142         - https://jira.onap.org/browse/VNFRQTS-195
143
144 **Security Issues**
145     - None
146
147 **Upgrade Notes**
148     - Requirements will still need to go and be updated in multiple
149       locations, but there is an upgrade proposal to handle this.
150
151 **Deprecation Notes**
152     - Chapter numbers will no longer be used, numbers for chapters
153       will be assigned dynamically based off of the header structure in rst.
154
155         - More information on the new header structure is available on `Headers <https://wiki.onap.org/display/DW/VNF+Requirement+Updated+Header+Structure>`_
156
157 **Other**
158     NA
159
160 Version: 1.0.0
161 --------------
162
163 :Release Date: 2017-11-16 (Amsterdam Release)
164
165 **New Features**
166
167     - Initial release of VNF Provider Guidelines and Requirements for
168       Open Network Automation Platform (ONAP)
169
170     - This initial releases is based on seed documents that came from Open-O
171       and Open ECOMP. For details, refer
172       `Seed Document Mappings to VNFRQTS Deliverable Outlines <https://wiki.onap.org/display/DW/Seed+Document+Mappings+to+VNFRQTS+Deliverable+Outlines>`_.
173
174     - This release provides a consolidated list of requirements as prototype
175       text for RFPs to acquire VNFs to run in an ONAP context. The
176       requirements are uniquely numbered and in a consistent format.
177
178 **Bug Fixes**
179     - None
180
181 **Known Issues**
182     - `VNFRQTS-83 Chapter 5, Section B Requirements <https://jira.onap.org/browse/VNFRQTS-83>`__.
183
184     - Heat requirements have not been formatted into the standard
185       format used throughout the document.
186
187     - Therefore they are not included in the summary of requirements
188       listed in Appendix 8.d.
189
190     - These requirements can be found by searching for the keywords must,
191       should in the sections of the document that discuss Heat.
192
193 **Security Issues**
194     - No known security issues.
195
196 **Upgrade Notes**
197     - Initial release - none
198
199 **Deprecation Notes**
200     - Initial release - none
201
202 **Other**
203     NA
204
205 ===========
206
207 End of Release Notes