Clarified release note

[doc.git] / docs / templates / sections / release-notes.rst

diff --git a/docs/templates/sections/release-notes.rst b/docs/templates/sections/release-notes.rst
index df61760..980d59a 100644 (file)
--- a/docs/templates/sections/release-notes.rst
+++ b/docs/templates/sections/release-notes.rst
@@ -1,60 +1,128 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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::
-        * This Release Notes must be updated each time the team decides to Release new artifacts.
-        * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes.
-        * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes.
-        * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release.
-        * This note must be removed after content has been added.
+   * 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
+========
 
-Version: x.y.z
---------------
+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 Date: yyyy-mm-dd
 
+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**
+New features
+------------
 
-One or two sentences explaining the purpose of this Release.
+<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.
 
-**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, three sentences.
-          One sentences explaining what is the issue.
 
-          Another sentence explaining the impact of the issue.
+- `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
+=========================================
 
-          And an optional sentence providing a workaround.
+System Limitations
+------------------
+
+Any known system limitations.
+
+
+Known Vulnerabilities
+---------------------
+
+Results of know vulnerabilities analysis in used modules.
+
+
+Workarounds
+-----------
+
+Any known workarounds.
+
+
+Security Notes
+--------------
 
-**Security Notes**
+**Fixed Security Issues**
 
-*Fixed Security Issues*
+List of security issues fixed in this release including CVEs and OJSI
+tickets.
 
-        List of security issues fixed in this release including CVEs and OJSI tickets.
+**Known Security Issues**
 
-*Known Security Issues*
+List of new security issues that are left unfixed in this release including
+CVEs and OJSI tickets.
 
-        List of new security issues that are left unfixed in this release including CVEs and OJSI tickets.
 
-*Known Vulnerabilities in Used Modules*
+Test Results
+============
+List or refer to any project specific results
 
-        Results of know vulnerabilities analysis in used modules.
 
-**Upgrade Notes**
+References
+==========
 
-**Deprecation Notes**
+For more information on the ONAP ``<release name>`` release, please see:
 
-**Other**
+#. `ONAP Home Page`_
+#. `ONAP Documentation`_
+#. `ONAP Release Downloads`_
+#. `ONAP Wiki Page`_
 
-===========
 
-End of Release Notes
+.. _`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