Gitiles
Code Review Sign In
gerrit.nordix.org / oransc / pti / rtp / b6d2696fd594467a909102ed5f9262fdf332ec1e / . / docs / release-notes.rst
blob: ceb4bf852a66f33cb433b3a64a0a75cc35e10013 [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
weichenb6d26962019-11-04 01:43:18 -0500[diff] [blame^]5Release-notes
6=============
7
8
Xiaohua Zhangd56a96b2019-10-25 09:32:32 +0800[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
weichenb6d26962019-11-04 01:43:18 -0500[diff] [blame^]35-------
Xiaohua Zhangd56a96b2019-10-25 09:32:32 +0800[diff] [blame]36
37<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
38
39
40
41
42Release Data
weichenb6d26962019-11-04 01:43:18 -0500[diff] [blame^]43------------
Xiaohua Zhangd56a96b2019-10-25 09:32:32 +0800[diff] [blame]44<STATE RELEVANT RELEASE DATA/RECORDS>
45
46<EXAMPLE>:
47
48+--------------------------------------+--------------------------------------+
weichenb6d26962019-11-04 01:43:18 -0500[diff] [blame^]49| **Project** | E.g. project |
Xiaohua Zhangd56a96b2019-10-25 09:32:32 +0800[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+--------------------------------------+--------------------------------------+
weichenb6d26962019-11-04 01:43:18 -0500[diff] [blame^]61| **Purpose of the delivery** | |
Xiaohua Zhangd56a96b2019-10-25 09:32:32 +0800[diff] [blame]62| | |
63+--------------------------------------+--------------------------------------+
64
65
66
67
68Feature additions
weichenb6d26962019-11-04 01:43:18 -0500[diff] [blame^]69^^^^^^^^^^^^^^^^^
Xiaohua Zhangd56a96b2019-10-25 09:32:32 +0800[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
89Bug corrections
weichenb6d26962019-11-04 01:43:18 -0500[diff] [blame^]90^^^^^^^^^^^^^^^
Xiaohua Zhangd56a96b2019-10-25 09:32:32 +0800[diff] [blame]91
92**JIRA TICKETS:**
93
94+--------------------------------------+--------------------------------------+
95| **JIRA REFERENCE** | **SLOGAN** |
96| | |
97+--------------------------------------+--------------------------------------+
98| | |
99| | |
100| | |
101+--------------------------------------+--------------------------------------+
102| | |
103| | |
104| | |
105+--------------------------------------+--------------------------------------+
106
107Deliverables
weichenb6d26962019-11-04 01:43:18 -0500[diff] [blame^]108^^^^^^^^^^^^
Xiaohua Zhangd56a96b2019-10-25 09:32:32 +0800[diff] [blame]109
110Software deliverables
weichenb6d26962019-11-04 01:43:18 -0500[diff] [blame^]111+++++++++++++++++++++
Xiaohua Zhangd56a96b2019-10-25 09:32:32 +0800[diff] [blame]112
113<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
114
weichenb6d26962019-11-04 01:43:18 -0500[diff] [blame^]115
Xiaohua Zhangd56a96b2019-10-25 09:32:32 +0800[diff] [blame]116
117Documentation deliverables
weichenb6d26962019-11-04 01:43:18 -0500[diff] [blame^]118++++++++++++++++++++++++++
Xiaohua Zhangd56a96b2019-10-25 09:32:32 +0800[diff] [blame]119
120<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
121
weichenb6d26962019-11-04 01:43:18 -0500[diff] [blame^]122
Xiaohua Zhangd56a96b2019-10-25 09:32:32 +0800[diff] [blame]123
124
125Known Limitations, Issues and Workarounds
weichenb6d26962019-11-04 01:43:18 -0500[diff] [blame^]126-----------------------------------------
Xiaohua Zhangd56a96b2019-10-25 09:32:32 +0800[diff] [blame]127
128System Limitations
weichenb6d26962019-11-04 01:43:18 -0500[diff] [blame^]129^^^^^^^^^^^^^^^^^^
Xiaohua Zhangd56a96b2019-10-25 09:32:32 +0800[diff] [blame]130<STATE ALL RELEVANT SYSTEM LIMITATIONS, IF THERE IS ANY>
131
132
133
134Known issues
weichenb6d26962019-11-04 01:43:18 -0500[diff] [blame^]135^^^^^^^^^^^^
Xiaohua Zhangd56a96b2019-10-25 09:32:32 +0800[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
weichenb6d26962019-11-04 01:43:18 -0500[diff] [blame^]156^^^^^^^^^^^
Xiaohua Zhangd56a96b2019-10-25 09:32:32 +0800[diff] [blame]157
158<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE, IF THERE IS ANY>
159
160
161
162
163References
weichenb6d26962019-11-04 01:43:18 -0500[diff] [blame^]164----------
Xiaohua Zhangd56a96b2019-10-25 09:32:32 +0800[diff] [blame]165<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
166
167
168
169