Altering the directory structures to fit the release plan, added template info for...

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)

diff --git a/docs/Brahmaputra/release-notes/index.rst b/docs/Brahmaputra/release-notes/index.rst
deleted file mode 100644 (file)
index 1607e23..0000000
--- 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 (file)
index be53176..0000000
--- 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
similarity index 100%
rename from docs/Brahmaputra/FAQ/FAQ.rst
rename to docs/FAQ/FAQ.rst

diff --git a/docs/Brahmaputra/FAQ/index.rst b/docs/FAQ/index.rst
similarity index 100%
rename from docs/Brahmaputra/FAQ/index.rst
rename to docs/FAQ/index.rst

diff --git a/docs/Brahmaputra/installation-instructions/index.rst b/docs/installation-instructions/index.rst
similarity index 65%
rename from docs/Brahmaputra/installation-instructions/index.rst
rename to docs/installation-instructions/index.rst
index b30982e..dc51516 100644 (file)
--- 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
similarity index 94%
rename from docs/Brahmaputra/installation-instructions/installation-instructions.rst
rename to docs/installation-instructions/installation-instructions.rst
index ba0ceaf..7fc3135 100644 (file)
--- 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 (file)
index 0000000..9afa96c
--- /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 (file)
index 0000000..df055d5
--- /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