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