summaryrefslogtreecommitdiffstats
path: root/docs/templates/sections/release-notes.rst
blob: 99eb015f236ff58ee27d3d74e497e7fb7744e0f5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
.. This work is licensed under a Creative Commons Attribution 4.0
   International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) ONAP Project and its contributors
.. _release_notes:

***********************
<project> Release Notes
***********************

.. note::
   * The release note needs to be updated for each ONAP release
   * Except the section "Release data" all other sections are optional and should be
     applied where applicable
   * Only the current release is to be documented in this document
   * This note needs to be removed before publishing the final result

Abstract
========

This document provides the release notes for the ``<releasename>`` release.

Summary
=======

<Give a high level description of your project with regards to this
specific release>


Release Data
============

+--------------------------------------+--------------------------------------+
| **Project**                          | <project name>                       |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Docker images**                    |  make sure you include all docker    |
|                                      |  images including the                |
|                                      |  release version                     |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release designation**              | <release name followed by version>   |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release date**                     | <DD/MM/YYYY>                         |
|                                      |                                      |
+--------------------------------------+--------------------------------------+

New features
------------

<Describe new features or other new additions>

**Bug fixes**

- `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining
  what this defect is addressing.

**Known Issues**

- `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two to three sentences
  explaining what this issue is.

Deliverables
------------

Software Deliverables
~~~~~~~~~~~~~~~~~~~~~


Documentation Deliverables
~~~~~~~~~~~~~~~~~~~~~~~~~~


Known Limitations, Issues and Workarounds
=========================================

System Limitations
------------------

Any known system limitations.


Known Vulnerabilities
---------------------

Results of know vulnerabilities analysis in used modules.


Workarounds
-----------

Any known workarounds.


Security Notes
--------------

**Fixed Security Issues**

List of security issues fixed in this release including CVEs and OJSI
tickets.

**Known Security Issues**

List of new security issues that are left unfixed in this release including
CVEs and OJSI tickets.


Test Results
============
List or refer to any project specific results


References
==========

For more information on the ONAP ``<release name>`` release, please see:

#. `ONAP Home Page`_
#. `ONAP Documentation`_
#. `ONAP Release Downloads`_
#. `ONAP Wiki Page`_


.. _`ONAP Home Page`: https://www.onap.org
.. _`ONAP Wiki Page`: https://wiki.onap.org
.. _`ONAP Documentation`: https://docs.onap.org
.. _`ONAP Release Downloads`: https://git.onap.org