blob: b0d65306010e07eb07caf016b49842699aa57fec [file] [log] [blame]
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
This document provides the release notes for <RELEASE> of <COMPONENT>.
.. contents::
:depth: 3
:local:
Version history
---------------
+--------------------+--------------------+--------------------+--------------------+
| **Date** | **Ver.** | **Author** | **Comment** |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
| 20XX-XX-XX | 0.1.0 | | First draft |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
| | 0.1.1 | | |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
| | 1.0 | | |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
Summary
=======
<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
Release Data
============
<STATE RELEVANT RELEASE DATA/RECORDS>
<EXAMPLE>:
+--------------------------------------+--------------------------------------+
| **Project** | E.g. Arno/genesis/fuel@opnfv |
| | |
+--------------------------------------+--------------------------------------+
| **Repo/commit-ID** | E.g. genesis/adf634a0d4..... |
| | |
+--------------------------------------+--------------------------------------+
| **Release designation** | E.g. Arno RC2 |
| | |
+--------------------------------------+--------------------------------------+
| **Release date** | E.g. 2015-04-16 |
| | |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery** | E.g. OPNFV Internal quality assurance|
| | |
+--------------------------------------+--------------------------------------+
Feature additions
~~~~~~~~~~~~~~~~~~~~~~~
<STATE ADDED FEATURES BY REFERENCE TO JIRA>
<EXAMPLE>:
**JIRA BACK-LOG:**
+--------------------------------------+--------------------------------------+
| **JIRA REFERENCE** | **SLOGAN** |
| | |
+--------------------------------------+--------------------------------------+
| | |
| | |
| | |
+--------------------------------------+--------------------------------------+
| | |
| | |
| | |
+--------------------------------------+--------------------------------------+
Bug corrections
~~~~~~~~~~~~~~~~~~~~~
**JIRA TICKETS:**
+--------------------------------------+--------------------------------------+
| **JIRA REFERENCE** | **SLOGAN** |
| | |
+--------------------------------------+--------------------------------------+
| | |
| | |
| | |
+--------------------------------------+--------------------------------------+
| | |
| | |
| | |
+--------------------------------------+--------------------------------------+
Deliverables
----------------
Software deliverables
^^^^^^^^^^^^^^^^^^^^^^^
<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
<EXAMPLE>:
Documentation deliverables
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
<EXAMPLE>:
Known Limitations, Issues and Workarounds
=========================================
System Limitations
^^^^^^^^^^^^^^^^^^^^
<STATE ALL RELEVANT SYSTEM LIMITATIONS, IF THERE IS ANY>
Known issues
^^^^^^^^^^^^^^^
<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
<EXAMPLE>:
**JIRA TICKETS:**
+--------------------------------------+--------------------------------------+
| **JIRA REFERENCE** | **SLOGAN** |
| | |
+--------------------------------------+--------------------------------------+
| | |
| | |
| | |
+--------------------------------------+--------------------------------------+
| | |
| | |
| | |
+--------------------------------------+--------------------------------------+
Workarounds
^^^^^^^^^^^^^^^^^
<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE, IF THERE IS ANY>
References
==========
<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>