Merge "Remove all trailing whitespaces in docs/*.rst"
[vnfrqts/requirements.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
4
5
6 VNF Requirements Release Notes
7 ================================
8
9 Version: 2.0.0
10 ------------------------
11
12 :Release Date: 2018-5-24 (Beijing Release)
13
14 **New Features**
15
16         -Chapter 5 Requirements changed from test to numbered requirements.
17                 *https://jira.onap.org/browse/VNFRQTS-83
18
19         -Chapter Header re-structured to help readability of documents.
20                 *https://jira.onap.org/browse/VNFRQTS-130
21                 *https://wiki.onap.org/display/DW/VNF+Requirement+Updated+Header+Structure
22
23         -Changed language to take into consider PNF (xNF).
24                 *https://jira.onap.org/browse/VNFRQTS-188
25                 *https://jira.onap.org/browse/VNFRQTS-189
26
27         -Added copyright License Header in all source files
28                 *https://jira.onap.org/browse/VNFRQTS-180
29
30 **Bug Fixes**
31
32         - Fixed Chapter Header Structure warnings.
33                 *https://jira.onap.org/browse/VNFRQTS-193
34
35         -Found table in Chapter 8 section C.2 that was not printing, corrected format.
36                 *https://jira.onap.org/browse/VNFRQTS-192
37
38         -Fixes for language within requirements from clarification/grammar.
39                 *- The full list of changes made to requirements  is available on `JIRA <https://jira.onap.org/projects/VNFRQTS/issues>`_
40
41 **Known Issues**
42
43         - 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>`_
44                 *https://jira.onap.org/browse/VNFRQTS-195
45
46 **Security Issues**
47
48         - None
49
50 **Upgrade Notes**
51
52         - Requirements will still need to go and be updated in multiple locations, but there is an upgrade proposal to handle this.
53
54 **Deprecation Notes**
55
56         - Chapter numbers will no longer be used, numbers for chapters will be assigned dynamically based off of the header structure in rst.
57                 *More information on the new header structure is available on `Headers <https://wiki.onap.org/display/DW/VNF+Requirement+Updated+Header+Structure>`_
58
59 **Other**
60
61
62 Version: 1.0.0
63 ------------------------
64
65
66 :Release Date: 2017-11-16 (Amsterdam Release)
67
68
69
70 **New Features**
71         Initial release of VNF Provider Guidelines and Requirements for Open Network Automation Platform (ONAP)
72
73         This intitial releases is based on seed documents that came from Open-O and Open ECOMP. For details, refer `Seed Document Mappings to VNFRQTS Deliverable Outlines <https://wiki.onap.org/display/DW/Seed+Document+Mappings+to+VNFRQTS+Deliverable+Outlines>`_.
74
75         This release provides a consolidated list of requirements as prototype text for RFPs to acquire VNFs to run in an ONAP context. The requirements are uniquely numbered and in a consistent format.
76
77 **Bug Fixes**
78         - None
79
80 **Known Issues**
81         - `VNFRQTS-83 Chapter 5, Section B Requirements <https://jira.onap.org/browse/VNFRQTS-83>`_.
82
83           - Heat requirments have not been formatted into the standard format used througout the document.
84
85           - Therefore they are not included in the summary of requirements listed in Appendix 8.d.
86
87           - These requirements can be found by searching for the keywords must, should in the sections of the document that discuss Heat.
88
89 **Security Issues**
90         - No known security issues.
91
92 **Upgrade Notes**
93         - Initial release - none
94
95 **Deprecation Notes**
96         - Initial release - none
97
98 **Other**
99
100 ===========
101
102 End of Release Notes