summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristopherPrice <christopher.price@ericsson.com>2016-02-10 14:42:05 +0100
committerJustin chi <chigang@huawei.com>2016-02-15 07:48:03 +0000
commit61a95e9b5457173e60faa57ea775f162e4cb4090 (patch)
treeb1303d9fbafe168c9d17d5652533dd0a4860b048
parentcb1ef07c291e091efed53b7cff51b9ddefbb4cd3 (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> (cherry picked from commit 41dd73771cfc1a04665bea26bb492aba58ea3f8a)
-rw-r--r--docs/Brahmaputra/release-notes/index.rst11
-rw-r--r--docs/Brahmaputra/release-notes/release-notes.rst40
-rw-r--r--docs/FAQ/FAQ.rst (renamed from docs/Brahmaputra/FAQ/FAQ.rst)0
-rw-r--r--docs/FAQ/index.rst (renamed from docs/Brahmaputra/FAQ/index.rst)0
-rw-r--r--docs/installation-instructions/index.rst (renamed from docs/Brahmaputra/installation-instructions/index.rst)4
-rw-r--r--docs/installation-instructions/installation-instructions.rst (renamed from docs/Brahmaputra/installation-instructions/installation-instructions.rst)23
-rw-r--r--docs/release-notes/index.rst15
-rw-r--r--docs/release-notes/release-notes.rst133
8 files changed, 160 insertions, 66 deletions
diff --git a/docs/Brahmaputra/release-notes/index.rst b/docs/Brahmaputra/release-notes/index.rst
deleted file mode 100644
index 1607e236..00000000
--- a/docs/Brahmaputra/release-notes/index.rst
+++ /dev/null
@@ -1,11 +0,0 @@
-********************************************
-OPNFV(Brahmaputra) Compass4nfv Release Notes
-********************************************
-
-Contents:
-
-.. toctree::
- :numbered:
- :maxdepth: 4
-
- release-notes.rst
diff --git a/docs/Brahmaputra/release-notes/release-notes.rst b/docs/Brahmaputra/release-notes/release-notes.rst
deleted file mode 100644
index be531766..00000000
--- a/docs/Brahmaputra/release-notes/release-notes.rst
+++ /dev/null
@@ -1,40 +0,0 @@
-====================================================================================================
-OPNFV release notes for the Brahmaputra release of OPNFV when using Compass4nfv as a deployment tool
-====================================================================================================
-
-
-.. contents:: Table of Contents
- :backlinks: none
-
-
-Abstract
-========
-
-This document describes release notes of OPNFV when using Compass4nfv as a
-deployment tool.
-
-License
-=======
-
-Brahmaputra release of OPNFV when using Compass4nfv as a deployment tool Docs
-(c) by Weidong Shao (HUAWEI) and Justin Chi (HUAWEI)
-
-Brahmaputra release of OPNFV when using Compass4nfv as a deployment tool Docs
-are licensed under a Creative Commons Attribution 4.0 International License.
-You should have received a copy of the license along with this.
-If not, see <http://creativecommons.org/licenses/by/4.0/>.
-
-Version history
-===============
-
-+--------------------+--------------------+--------------------+---------------------------+
-| **Date** | **Ver.** | **Author** | **Comment** |
-| | | | |
-+--------------------+--------------------+--------------------+---------------------------+
-| 2016-01-17 | 0.0.1 | Justin Chi | First draft |
-| | | (HUAWEI) | |
-+--------------------+--------------------+--------------------+---------------------------+
-
-
-:Authors: Justin Chi (HUAWEI)
-:Version: 0.0.1
diff --git a/docs/Brahmaputra/FAQ/FAQ.rst b/docs/FAQ/FAQ.rst
index e32bd503..e32bd503 100644
--- a/docs/Brahmaputra/FAQ/FAQ.rst
+++ b/docs/FAQ/FAQ.rst
diff --git a/docs/Brahmaputra/FAQ/index.rst b/docs/FAQ/index.rst
index 0a072875..0a072875 100644
--- a/docs/Brahmaputra/FAQ/index.rst
+++ b/docs/FAQ/index.rst
diff --git a/docs/Brahmaputra/installation-instructions/index.rst b/docs/installation-instructions/index.rst
index b30982e4..dc51516e 100644
--- a/docs/Brahmaputra/installation-instructions/index.rst
+++ b/docs/installation-instructions/index.rst
@@ -1,3 +1,6 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
+
********************************************************
OPNFV(Brahmaputra) Compass4nfv installation instructions
********************************************************
@@ -9,3 +12,4 @@ Contents:
:maxdepth: 4
installation-instructions.rst
+
diff --git a/docs/Brahmaputra/installation-instructions/installation-instructions.rst b/docs/installation-instructions/installation-instructions.rst
index ba0ceafe..7fc3135a 100644
--- a/docs/Brahmaputra/installation-instructions/installation-instructions.rst
+++ b/docs/installation-instructions/installation-instructions.rst
@@ -1,6 +1,10 @@
-================================================================================================================
-OPNFV Installation instructions for the Brahmaputra release of OPNFV when using Compass4nfv as a deployment tool
-================================================================================================================
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) by Weidong Shao (HUAWEI) and Justin Chi (HUAWEI)
+
+==========================================================================================================
+Installation instructions for the Brahmaputra release of OPNFV when using Compass4nfv as a deployment tool
+==========================================================================================================
.. contents:: Table of Contents
@@ -14,17 +18,6 @@ This document describes how to install the Brahmaputra release of OPNFV when
using Compass4nfv as a deployment tool covering it's limitations, dependencies
and required system resources.
-License
-=======
-
-Brahmaputra release of OPNFV when using Compass4nfv as a deployment tool Docs
-(c) by Weidong Shao (HUAWEI) and Justin Chi (HUAWEI)
-
-Brahmaputra release of OPNFV when using Compass4nfv as a deployment tool Docs
-are licensed under a Creative Commons Attribution 4.0 International License.
-You should have received a copy of the license along with this.
-If not, see <http://creativecommons.org/licenses/by/4.0/>.
-
Version history
===============
@@ -411,4 +404,4 @@ Compass
`Compass Home Page <http://www.syscompass.org/>`_
:Authors: Justin Chi (HUAWEI)
-:Version: 1.0.0
+
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