Merge "Refined release note template"

[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 9b6688c..238b70b 100644 (file)
--- a/docs/templates/sections/release-notes.rst
+++ b/docs/templates/sections/release-notes.rst
@@ -1,50 +1,94 @@
 .. 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
 
+***********************
+<project> Release Notes
+***********************
 
-Release Notes
-=============
+Abstract
+========
 
-.. 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.
+This document provides the release notes for the ``<releasename>`` release.
 
+Summary
+=======
 
-Version: x.y.z
---------------
+<Give a high level description of your project with regards to this specific release>
+
+
+Release Data
+============
+
++--------------------------------------+--------------------------------------+
+| **Project**                          |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Docker images**                    | make sure you include all docker     |
+|                                      |  images including the                |
+|                                      |  release version                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release designation**              |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+New features
+------------
+
+<Describe new features or other new additions>
+
+
+Deliverables
+------------
 
+Software Deliverables
+~~~~~~~~~~~~~~~~~~~~~
 
-:Release Date: yyyy-mm-dd
 
+Documentation Deliverables
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
-**New Features**
+Known Limitations, Issues and Workarounds
+=========================================
 
-One or two sentences explaining the purpose of this Release.
+System Limitations
+------------------
+
+
+Known Vulnerabilities
+---------------------
+
+
+Workarounds
+-----------
+
+
+Security Notes
+--------------
 
-**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.
-         
-         And an optional sentence providing a workaround.
 
-**Security Issues**
-       You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_
+Test Results
+============
+List or refer to any project specific results
 
 
-**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