From: Sofia Wallin <sofia.wallin@ericsson.com>
Date: Wed, 10 Feb 2016 12:05:23 +0000 (+0100)
Subject: Created a template for release notes
X-Git-Tag: colorado.1.0~253^2
X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F15%2F9715%2F1;p=joid.git

Created a template for release notes

Please use this template for to write the release notes for Brahmaputra release.
We appreciate your work as soon as possible.

Change-Id: Ib4a6a1b899ec610459bae959bb4ce844d37378ac
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
---

diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst
new file mode 100644
index 00000000..c8cad46f
--- /dev/null
+++ b/docs/release-notes/index.rst
@@ -0,0 +1,14 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+=======================
+<project> Release Notes
+=======================
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   release-notes.rst
+
diff --git a/docs/release-notes/release-notes.rst b/docs/release-notes/release-notes.rst
new file mode 100644
index 00000000..545e1d9b
--- /dev/null
+++ b/docs/release-notes/release-notes.rst
@@ -0,0 +1,132 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+=================================================
+Release Note for the Brahmaputra release of OPNFV
+=================================================
+
+.. toctree::
+   :maxdepth: 2
+
+Abstract
+========
+
+This document compiles the release notes for the Brahmaputra release of
+OPNFV when using <XYZ> as a deployment tool.
+
+Introduction
+============
+
+Provide a breif introduction of how this release is used in OPNFV relese using <XYZ> as a deployment tool
+
+Be sure to reference your installation-instructions.
+
+Release Data
+============
+
++--------------------------------------+--------------------------------------+
+| **Project**                          |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Repo/tag**                         |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release designation**              |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery**          |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+Deliverables
+------------
+
+Software deliverables
+~~~~~~~~~~~~~~~~~~~~~
+<XYZ>-based installer iso file <iso file version>
+
+Documentation deliverables
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+-
+
+Version change
+--------------
+.. This section describes the changes made since the last version of this document.
+
+Module version change
+~~~~~~~~~~~~~~~~~~~~~
+
+Document version change
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Reason for new version
+----------------------
+
+Feature additions
+~~~~~~~~~~~~~~~~~
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE**                   | **SLOGAN**                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| JIRA:                                |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| JIRA:                                |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+Bug corrections
+~~~~~~~~~~~~~~~
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE**                   | **SLOGAN**                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| JIRA:                                |                                      |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+
+Known Limitations, Issues and Workarounds
+=========================================
+
+System Limitations
+------------------
+
+Known issues
+------------
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE**                   | **SLOGAN**                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| JIRA:                                |                                      |
++--------------------------------------+--------------------------------------+
+| JIRA:                                |                                      |
++--------------------------------------+--------------------------------------+
+
+
+Workarounds
+-----------
+See JIRA: <link>
+
+
+Test Result
+===========
+Brahmaputra test result using <XYZ> as deployment tool.
+<link>
+
+References
+==========
+For more information on the OPNFV Brahmaputra release, please visit
+http://www.opnfv.org/brahmaputra
+