Gitiles
Code Review Sign In
gerrit.nordix.org / oransc / pti / rtp / 10ae2782924109ca3573a82b1c1137108b589233 / . / docs / release-notes.rst
blob: b0d65306010e07eb07caf016b49842699aa57fec [file] [log] [blame]
Xiaohua Zhangd56a96b2019-10-25 09:32:32 +0800[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
3
4
5This document provides the release notes for <RELEASE> of <COMPONENT>.
6
7.. contents::
8 :depth: 3
9 :local:
10
11
12Version history
13---------------
14
15+--------------------+--------------------+--------------------+--------------------+
16| **Date** | **Ver.** | **Author** | **Comment** |
17| | | | |
18+--------------------+--------------------+--------------------+--------------------+
19| 20XX-XX-XX | 0.1.0 | | First draft |
20| | | | |
21+--------------------+--------------------+--------------------+--------------------+
22| | 0.1.1 | | |
23| | | | |
24+--------------------+--------------------+--------------------+--------------------+
25| | 1.0 | | |
26| | | | |
27+--------------------+--------------------+--------------------+--------------------+
28
29
30Summary
31=======
32
33<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
34
35
36
37
38Release Data
39============
40<STATE RELEVANT RELEASE DATA/RECORDS>
41
42<EXAMPLE>:
43
44+--------------------------------------+--------------------------------------+
45| **Project** | E.g. Arno/genesis/fuel@opnfv |
46| | |
47+--------------------------------------+--------------------------------------+
48| **Repo/commit-ID** | E.g. genesis/adf634a0d4..... |
49| | |
50+--------------------------------------+--------------------------------------+
51| **Release designation** | E.g. Arno RC2 |
52| | |
53+--------------------------------------+--------------------------------------+
54| **Release date** | E.g. 2015-04-16 |
55| | |
56+--------------------------------------+--------------------------------------+
57| **Purpose of the delivery** | E.g. OPNFV Internal quality assurance|
58| | |
59+--------------------------------------+--------------------------------------+
60
61
62
63
64Feature additions
65~~~~~~~~~~~~~~~~~~~~~~~
66<STATE ADDED FEATURES BY REFERENCE TO JIRA>
67
68<EXAMPLE>:
69
70**JIRA BACK-LOG:**
71
72+--------------------------------------+--------------------------------------+
73| **JIRA REFERENCE** | **SLOGAN** |
74| | |
75+--------------------------------------+--------------------------------------+
76| | |
77| | |
78| | |
79+--------------------------------------+--------------------------------------+
80| | |
81| | |
82| | |
83+--------------------------------------+--------------------------------------+
84
85Bug corrections
86~~~~~~~~~~~~~~~~~~~~~
87
88**JIRA TICKETS:**
89
90+--------------------------------------+--------------------------------------+
91| **JIRA REFERENCE** | **SLOGAN** |
92| | |
93+--------------------------------------+--------------------------------------+
94| | |
95| | |
96| | |
97+--------------------------------------+--------------------------------------+
98| | |
99| | |
100| | |
101+--------------------------------------+--------------------------------------+
102
103Deliverables
104----------------
105
106Software deliverables
107^^^^^^^^^^^^^^^^^^^^^^^
108
109<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
110
111<EXAMPLE>:
112
113Documentation deliverables
114^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
115
116<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
117
118<EXAMPLE>:
119
120
121Known Limitations, Issues and Workarounds
122=========================================
123
124System Limitations
125^^^^^^^^^^^^^^^^^^^^
126<STATE ALL RELEVANT SYSTEM LIMITATIONS, IF THERE IS ANY>
127
128
129
130Known issues
131^^^^^^^^^^^^^^^
132<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
133
134<EXAMPLE>:
135
136**JIRA TICKETS:**
137
138+--------------------------------------+--------------------------------------+
139| **JIRA REFERENCE** | **SLOGAN** |
140| | |
141+--------------------------------------+--------------------------------------+
142| | |
143| | |
144| | |
145+--------------------------------------+--------------------------------------+
146| | |
147| | |
148| | |
149+--------------------------------------+--------------------------------------+
150
151Workarounds
152^^^^^^^^^^^^^^^^^
153
154<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE, IF THERE IS ANY>
155
156
157
158
159References
160==========
161<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
162
163
164
165