1 .. This work is licensed under a Creative Commons Attribution 4.0
3 .. http://creativecommons.org/licenses/by/4.0
4 .. (c) ONAP Project and its contributors
6 ***********************
7 <project> Release Notes
8 ***********************
11 * The release note needs to be updated for each ONAP release
12 * Except the section "Release data" all other sections are optional and should be
13 applied where applicable
14 * Only the current release is to be documented in this document
15 * This note needs to be removed before publishing the final result
20 This document provides the release notes for the ``<releasename>`` release.
25 <Give a high level description of your project with regards to this
32 +--------------------------------------+--------------------------------------+
33 | **Project** | <project name> |
35 +--------------------------------------+--------------------------------------+
36 | **Docker images** | make sure you include all docker |
37 | | images including the |
40 +--------------------------------------+--------------------------------------+
41 | **Release designation** | <release name followed by version> |
43 +--------------------------------------+--------------------------------------+
44 | **Release date** | <DD/MM/YYYY> |
46 +--------------------------------------+--------------------------------------+
51 <Describe new features or other new additions>
55 - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining
56 what this defect is addressing.
60 - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two to three sentences
61 explaining what this issue is.
70 Documentation Deliverables
71 ~~~~~~~~~~~~~~~~~~~~~~~~~~
74 Known Limitations, Issues and Workarounds
75 =========================================
80 Any known system limitations.
86 Results of know vulnerabilities analysis in used modules.
92 Any known workarounds.
98 **Fixed Security Issues**
100 List of security issues fixed in this release including CVEs and OJSI
103 **Known Security Issues**
105 List of new security issues that are left unfixed in this release including
106 CVEs and OJSI tickets.
111 List or refer to any project specific results
117 For more information on the ONAP ``<release name>`` release, please see:
120 #. `ONAP Documentation`_
121 #. `ONAP Release Downloads`_
125 .. _`ONAP Home Page`: https://www.onap.org
126 .. _`ONAP Wiki Page`: https://wiki.onap.org
127 .. _`ONAP Documentation`: https://docs.onap.org
128 .. _`ONAP Release Downloads`: https://git.onap.org