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
7 ***********************
8 <project> Release Notes
9 ***********************
12 * The release note needs to be updated for each ONAP release
13 * Except the section "Release data" all other sections are optional and should be
14 applied where applicable
15 * Only the current release is to be documented in this document
16 * This note needs to be removed before publishing the final result
21 This document provides the release notes for the ``<releasename>`` release.
26 <Give a high level description of your project with regards to this
33 +--------------------------------------+--------------------------------------+
34 | **Project** | <project name> |
36 +--------------------------------------+--------------------------------------+
37 | **Docker images** | make sure you include all docker |
38 | | images including the |
41 +--------------------------------------+--------------------------------------+
42 | **Release designation** | <release name followed by version> |
44 +--------------------------------------+--------------------------------------+
45 | **Release date** | <DD/MM/YYYY> |
47 +--------------------------------------+--------------------------------------+
52 <Describe new features or other new additions>
56 - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining
57 what this defect is addressing.
61 - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two to three sentences
62 explaining what this issue is.
71 Documentation Deliverables
72 ~~~~~~~~~~~~~~~~~~~~~~~~~~
75 Known Limitations, Issues and Workarounds
76 =========================================
81 Any known system limitations.
87 Results of know vulnerabilities analysis in used modules.
93 Any known workarounds.
99 **Fixed Security Issues**
101 List of security issues fixed in this release including CVEs and OJSI
104 **Known Security Issues**
106 List of new security issues that are left unfixed in this release including
107 CVEs and OJSI tickets.
112 List or refer to any project specific results
118 For more information on the ONAP ``<release name>`` release, please see:
121 #. `ONAP Documentation`_
122 #. `ONAP Release Downloads`_
126 .. _`ONAP Home Page`: https://www.onap.org
127 .. _`ONAP Wiki Page`: https://wiki.onap.org
128 .. _`ONAP Documentation`: https://docs.onap.org
129 .. _`ONAP Release Downloads`: https://git.onap.org