aboutsummaryrefslogtreecommitdiffstats
path: root/docs/release-notes
diff options
context:
space:
mode:
authorChristopherPrice <christopher.price@ericsson.com>2016-02-10 14:42:05 +0100
committerChristopherPrice <christopher.price@ericsson.com>2016-02-10 14:42:05 +0100
commit41dd73771cfc1a04665bea26bb492aba58ea3f8a (patch)
tree157fe193d034e60cf917188cd910a0c17524339f /docs/release-notes
parentab495546af8ba0fe9ea1234e4f25a7e62ed92191 (diff)
Altering the directory structures to fit the release plan, added template info for release notes.
Moved the folders from Brahmaputra to docs. The toolchain for stable/brahmaputra will add the Brahmaputra directory automatically. Added template information for the release-notes document Change-Id: Id77cce6f53a6e7a9567b0651f3ce68e1518851f1 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
Diffstat (limited to 'docs/release-notes')
-rw-r--r--docs/release-notes/index.rst15
-rw-r--r--docs/release-notes/release-notes.rst133
2 files changed, 148 insertions, 0 deletions
diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst
new file mode 100644
index 00000000..9afa96c2
--- /dev/null
+++ b/docs/release-notes/index.rst
@@ -0,0 +1,15 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
+
+============================================
+OPNFV(Brahmaputra) Compass4nfv Release Notes
+============================================
+
+Contents:
+
+.. 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..df055d5f
--- /dev/null
+++ b/docs/release-notes/release-notes.rst
@@ -0,0 +1,133 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Weidong Shao (HUAWEI) and Justin Chi (HUAWEI)
+
+=============================================================================================
+Release Note for the Brahmaputra release of OPNFV when using Compass4nfv as a deployment tool
+=============================================================================================
+
+
+.. toctree::
+ :maxdepth: 2
+
+Abstract
+========
+
+This document describes release notes of OPNFV when using Compass4nfv as a
+deployment tool.
+
+Introduction
+============
+
+Provide a brief introduction of how this release is used in OPNFV release 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
+
+:Authors: Justin Chi (HUAWEI)
+:Version: 0.0.1