Merge "Updated to use new docs structure WIP"

31 files changed, 287 insertions, 108 deletions

diff --git a/docs/design/featureconfig_link.rst b/docs/design/featureconfig_link.rst
deleted file mode 100644
index 6af66f7..0000000
--- a/docs/design/featureconfig_link.rst
+++ /dev/null
@@ -1,2 +0,0 @@
-.. include::
-   ../installationprocedure/feature.configuration.rst
diff --git a/docs/design/featureusage_link.rst b/docs/design/featureusage_link.rst
deleted file mode 100644
index c3ac10b..0000000
--- a/docs/design/featureusage_link.rst
+++ /dev/null
@@ -1,2 +0,0 @@
-.. include::
-   ../userguide/feature.usage.rst
diff --git a/docs/design/index.rst b/docs/design/index.rst
deleted file mode 100644
index b1bc74b..0000000
--- a/docs/design/index.rst
+++ /dev/null
@@ -1,22 +0,0 @@
-.. This work is licensed under a
-.. Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) 2015-2017 AT&T Intellectual Property, Inc
-
-********************
-OPNFV Copper Project
-********************
-
-.. toctree::
-   :numbered:
-   :maxdepth: 4
-
-   introduction.rst
-   releasenotes_link.rst
-   definitions.rst
-   usecases.rst
-   architecture.rst
-   requirements.rst
-   featureconfig_link.rst
-   postinstall_link.rst
-   featureusage_link.rst
diff --git a/docs/design/postinstall_link.rst b/docs/design/postinstall_link.rst
deleted file mode 100644
index ca8d99c..0000000
--- a/docs/design/postinstall_link.rst
+++ /dev/null
@@ -1,2 +0,0 @@
-.. include::
-   ../installationprocedure/installation.instruction.rst
diff --git a/docs/design/releasenotes_link.rst b/docs/design/releasenotes_link.rst
deleted file mode 100644
index 6ee81a3..0000000
--- a/docs/design/releasenotes_link.rst
+++ /dev/null
@@ -1,2 +0,0 @@
-.. include::
-   ../releasenotes/release.notes.rst
diff --git a/docs/design/architecture.rst b/docs/development/design/architecture.rst
index 02d8335..02d8335 100644
--- a/docs/design/architecture.rst
+++ b/docs/development/design/architecture.rst
diff --git a/docs/design/conf.py b/docs/development/design/conf.py
index 99b1ca2..99b1ca2 100644
--- a/docs/design/conf.py
+++ b/docs/development/design/conf.py
diff --git a/docs/design/definitions.rst b/docs/development/design/definitions.rst
index 5552696..5552696 100644
--- a/docs/design/definitions.rst
+++ b/docs/development/design/definitions.rst
diff --git a/docs/design/images/policy_architecture.png b/docs/development/design/images/policy_architecture.png
index eb37e36..eb37e36 100644
--- a/docs/design/images/policy_architecture.png
+++ b/docs/development/design/images/policy_architecture.png
diff --git a/docs/design/images/policy_architecture.pptx b/docs/development/design/images/policy_architecture.pptx
index 5739f0f..5739f0f 100644
--- a/docs/design/images/policy_architecture.pptx
+++ b/docs/development/design/images/policy_architecture.pptx
diff --git a/docs/development/design/index.rst b/docs/development/design/index.rst
new file mode 100644
index 0000000..aa51e54
--- /dev/null
+++ b/docs/development/design/index.rst
@@ -0,0 +1,15 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+==========================
+OPNFV Copper Danube Design
+==========================
+
+.. toctree::
+   :maxdepth: 1
+
+   definitions.rst
+   architecture.rst
+
diff --git a/docs/development/overview/index.rst b/docs/development/overview/index.rst
new file mode 100644
index 0000000..e9c69e0
--- /dev/null
+++ b/docs/development/overview/index.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+============================
+OPNFV Copper Danube Overview
+============================
+
+.. toctree::
+   :maxdepth: 1
+
+   overview.rst
diff --git a/docs/design/introduction.rst b/docs/development/overview/overview.rst
index cc2ceee..2a27e49 100644
--- a/docs/design/introduction.rst
+++ b/docs/development/overview/overview.rst
@@ -1,18 +1,13 @@
-.. This work is licensed under a
-.. Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) 2015-2017 AT&T Intellectual Property, Inc
+==============================================
+OPNFV Danube Copper Overview
+==============================================
 
-Introduction
-============
-
-..
- This work is licensed under a Creative Commons Attribution 4.0 Unported License.
+.. contents::
+   :depth: 3
+   :local:
 
- http://creativecommons.org/licenses/by/4.0
-
-.. NOTE::
-   This is the working documentation for the Copper project.
+Introduction
+------------
 
 The `OPNFV Copper <https://wiki.opnfv.org/copper>`_ project aims to help ensure
 that virtualized infrastructure and application deployments comply with goals of
diff --git a/docs/development/requirements/index.rst b/docs/development/requirements/index.rst
new file mode 100644
index 0000000..611fbe2
--- /dev/null
+++ b/docs/development/requirements/index.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+================================
+OPNFV Copper Danube Requirements
+================================
+
+.. toctree::
+   :maxdepth: 1
+
+   requirements.rst
diff --git a/docs/design/requirements.rst b/docs/development/requirements/requirements.rst
index 87894cf..87894cf 100644
--- a/docs/design/requirements.rst
+++ b/docs/development/requirements/requirements.rst
diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst
deleted file mode 100644
index 2776b88..0000000
--- a/docs/installationprocedure/index.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-***********************************
-OPNFV Copper Installation Procedure
-***********************************
-
-.. toctree::
-   :numbered:
-   :maxdepth: 4
-
-   feature.configuration.rst
-   installation.instruction.rst
diff --git a/docs/release/configguide/featureconfig.rst b/docs/release/configguide/featureconfig.rst
new file mode 100644
index 0000000..0669172
--- /dev/null
+++ b/docs/release/configguide/featureconfig.rst
@@ -0,0 +1,23 @@
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+Copper Configuration
+====================
+This release includes installer support for the OpenStack Congress service under
+JOID and Apex installers. Congress is installed by default for all JOID and Apex
+scenarios. Support for other OPNFV installer deployed environments is planned
+for the next release.
+
+.. contents::
+   :depth: 3
+   :local:
+
+Pre-configuration Activities
+----------------------------
+None required.
+
+Hardware Configuration
+----------------------
+There is no specific hardware configuration required for the Copper project.
diff --git a/docs/release/configguide/index.rst b/docs/release/configguide/index.rst
new file mode 100644
index 0000000..b9454e2
--- /dev/null
+++ b/docs/release/configguide/index.rst
@@ -0,0 +1,14 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+================================
+OPNFV Copper Configuration Guide
+================================
+
+.. toctree::
+   :maxdepth: 1
+
+   featureconfig.rst
+   postinstall.rst
diff --git a/docs/installationprocedure/installation.instruction.rst b/docs/release/configguide/postinstall.rst
index da3918e..2f959ad 100644
--- a/docs/installationprocedure/installation.instruction.rst
+++ b/docs/release/configguide/postinstall.rst
@@ -7,8 +7,7 @@ Copper Post Installation Procedures
 ===================================
 
 This section describes optional procedures for verifying that the Congress
-service is operational as well as additional test tools developed for the Colorado
-release.
+service is operational.
 
 Copper Functional Tests
 -----------------------
diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst
new file mode 100644
index 0000000..73edca1
--- /dev/null
+++ b/docs/release/installation/index.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+=========================
+OPNFV Copper Installation
+=========================
+
+.. toctree::
+   :maxdepth: 1
+
+   installation.instruction
diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/release/installation/installation.instruction.rst
index 54eab4b..fa3732e 100644
--- a/docs/installationprocedure/feature.configuration.rst
+++ b/docs/release/installation/installation.instruction.rst
@@ -1,29 +1,29 @@
-.. This work is licensed under a
-.. Creative Commons Attribution 4.0 International License.
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-.. (c) 2015-2017 AT&T Intellectual Property, Inc
 
-Copper Configuration
-====================
-This release includes installer support for the OpenStack Congress service under
-JOID and Apex installers. Congress is installed by default for all JOID and Apex
-scenarios. Support for other OPNFV installer deployed environments is planned
-for the next release.
+===============================
+OPNFV Copper Installation Guide
+===============================
 
-Pre-configuration Activities
-----------------------------
-None required.
+This document describes how to install Copper, its dependencies and required system resources.
 
-Hardware Configuration
-----------------------
-There is no specific hardware configuration required for the Copper project.
+.. contents::
+   :depth: 3
+   :local:
 
-Feature Configuration
----------------------
+Version History
+---------------
 
-OPNFV Installer Support
-.......................
++--------------------+--------------------+--------------------+--------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2017 Feb 7         | 1.0                | Bryan Sullivan     |                    |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
 
+Introduction
+------------
 The Congress service is automatically configured as required by the JOID and
 Apex installers, including creation of datasources per the installed datasource
 drivers. This release includes default support for the following datasource drivers:
@@ -43,7 +43,7 @@ Other project installer support (e.g. Doctor) may install additional datasource
 drivers once Congress is installed.
 
 Manual Installation
-...................
+-------------------
 
 NOTE: This section describes a manual install procedure that had been tested
 under the JOID and Apex base installs prior to the integration of native
@@ -76,7 +76,3 @@ specifying the branch identifier to use for OpenStack.
    wget https://git.opnfv.org/cgit/copper/plain/components/congress/install/bash/install_congress_1.sh
    wget https://git.opnfv.org/cgit/copper/plain/components/congress/install/bash/install_congress_2.sh
    bash install_congress_1.sh [openstack-branch]
-
-Copper Post Configuration Procedures
-------------------------------------
-No configuration procedures are required beyond the basic install procedure.
diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst
new file mode 100644
index 0000000..963d2e3
--- /dev/null
+++ b/docs/release/release-notes/index.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+==========================
+OPNFV Copper Release Notes
+==========================
+
+.. toctree::
+   :maxdepth: 1
+
+   release-notes.rst
diff --git a/docs/releasenotes/release.notes.rst b/docs/release/release-notes/release-notes.rst
index c85a900..b77e049 100644
--- a/docs/releasenotes/release.notes.rst
+++ b/docs/release/release-notes/release-notes.rst
@@ -3,11 +3,42 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) 2015-2017 AT&T Intellectual Property, Inc
 
-Release Notes
-=============
+======================================================================
+OPNFV Copper Release Notes
+======================================================================
+
+This document provides the release notes for the Danube Release of Copper.
+
+.. contents::
+   :depth: 3
+   :local:
+
+
+Version History
+---------------
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**        |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2017 Feb 7         | 1.0                | Bryan Sullivan     |                    |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+
+Important Notes
+---------------
+
+
+Summary
+-------
+
+The Danube release of OPNFV Copper is based on OpenStack Newton.
+
+Release Data
+------------
 
 Copper Release 1 Scope
-----------------------
+^^^^^^^^^^^^^^^^^^^^^^
 OPNFV Brahmaputra was the initial OPNFV release for Copper, and achieved the
 goals:
 
@@ -16,7 +47,7 @@ goals:
   * Provide basis tests scripts and tools to exercise the Congress service
 
 Copper Release 2 Scope
-----------------------
+^^^^^^^^^^^^^^^^^^^^^^
 OPNFV Colorado includes the additional features:
   * Congress support in the the OPNFV CI/CD pipeline for the JOID and Apex
     installers, through the following projects being upstreamed to OpenStack:
@@ -28,7 +59,7 @@ OPNFV Colorado includes the additional features:
   * Further enhancements of Congress test tools
 
 Copper Release 3 Scope
-----------------------
+^^^^^^^^^^^^^^^^^^^^^^
 OPNFV Danube includes the additional features:
   * Manual tests
 
@@ -36,8 +67,15 @@ OPNFV Danube includes the additional features:
 
   * Further enhancements of Congress test scripts
 
-Limitations
-===========
+Version Change
+^^^^^^^^^^^^^^
+
+Module Version Changes
+~~~~~~~~~~~~~~~~~~~~~~
+- Openstack has changed from Mitaka to Newton
+
+Known Limitations, Issues and Workarounds
+-----------------------------------------
 
 The following features have not been verified as of this release:
 
@@ -49,3 +87,4 @@ The following features have not been verified as of this release:
   * Horizon plugin: The Congress OpenStack Dashboard plugin (a "Policy tab") has not been
     deployed in OPNFV as of this release. Installing the needed Congress Dashboard plugin
     files on the OpenStack Dashboard host is a future work item.
+
diff --git a/docs/release/scenarios/scenario.name/index.rst b/docs/release/scenarios/scenario.name/index.rst
new file mode 100644
index 0000000..9b710da
--- /dev/null
+++ b/docs/release/scenarios/scenario.name/index.rst
@@ -0,0 +1,17 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+==================
+<scenario name>
+==================
+.. This document will be used to provide a description of the scenario for an end user.
+.. You should explain the purpose of the scenario, the types of capabilities provided and
+..  the unique components that make up the scenario including how they are used.
+
+.. toctree::
+   :maxdepth: 1
+
+   scenario.description
+
diff --git a/docs/release/scenarios/scenario.name/scenario.description.rst b/docs/release/scenarios/scenario.name/scenario.description.rst
new file mode 100644
index 0000000..af6e41b
--- /dev/null
+++ b/docs/release/scenarios/scenario.name/scenario.description.rst
@@ -0,0 +1,43 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+=========================
+OPNFV <Scenario Name>
+=========================
+
+This document provides scenario level details for <RELEASE> of <COMPONENT>.
+
+.. contents::
+   :depth: 3
+   :local:
+
+Introduction
+---------------
+.. In this section explain the purpose of the scenario and the types of capabilities provided
+
+Scenario components and composition
+-------------------------------------
+.. In this section describe the unique components that make up the scenario,
+.. what each component provides and why it has been included in order
+.. to communicate to the user the capabilities available in this scenario.
+
+Scenario usage overview
+----------------------------
+.. Provide a brief overview on how to use the scenario and the features available to the
+.. user.  This should be an "introduction" to the userguide document, and explicitly link to it,
+.. where the specifics of the features are covered including examples and API's
+
+Limitations, Issues and Workarounds
+---------------------------------------
+.. Explain scenario limitations here, this should be at a design level rather than discussing
+.. faults or bugs.  If the system design only provide some expected functionality then provide
+.. some insight at this point.
+
+References
+-----------------
+
+For more information on the OPNFV Danube release, please visit
+http://www.opnfv.org/danube
+
diff --git a/docs/userguide/feature.usage.rst b/docs/release/userguide/feature.userguide.rst
index 4db4533..c43a502 100644
--- a/docs/userguide/feature.usage.rst
+++ b/docs/release/userguide/feature.userguide.rst
@@ -3,8 +3,14 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) 2015-2017 AT&T Intellectual Property, Inc
 
-Copper Capabilities and Usage
-=============================
+=======================
+OPNFV Copper User Guide
+=======================
+
+.. contents::
+   :depth: 3
+   :local:
+
 This release focuses on use of the OpenStack Congress service for managing
 configuration policy. See the Congress `intro guide <http://docs.openstack.org/developer/congress/index.html>`_
 for general information on the capabilities and usage of Congress.
diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst
new file mode 100644
index 0000000..1004c3e
--- /dev/null
+++ b/docs/release/userguide/index.rst
@@ -0,0 +1,24 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+=======================
+OPNFV Copper User Guide
+=======================
+
+.. The feature user guide should provide an OPNFV user with enough information to
+.. use the features provided by the feature project in the supported scenarios.
+.. This guide should walk a user through the usage of the features once a scenario
+.. has been deployed and is active according to the installation guide provided
+.. by the installer project.
+
+.. toctree::
+   :maxdepth: 1
+
+   feature.userguide
+.. The feature.userguide.rst file should contain the text for this document
+.. additional documents can be added to this directory and added in the right order
+.. to this file as a list below.
+
+
diff --git a/docs/releasenotes/index.rst b/docs/releasenotes/index.rst
deleted file mode 100644
index 78b1722..0000000
--- a/docs/releasenotes/index.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-**************************
-OPNFV Copper Release Notes
-**************************
-
-.. toctree::
-   :numbered:
-   :maxdepth: 4
-
-   release.notes.rst
diff --git a/docs/testing/index.rst b/docs/testing/index.rst
new file mode 100644
index 0000000..94c0913
--- /dev/null
+++ b/docs/testing/index.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015-2017 AT&T Intellectual Property, Inc
+
+===========================
+OPNFV Copper Danube Testing
+===========================
+
+.. toctree::
+   :maxdepth: 1
+
+   usecases.rst
diff --git a/docs/design/usecases.rst b/docs/testing/usecases.rst
index 431590d..d6c09e5 100644
--- a/docs/design/usecases.rst
+++ b/docs/testing/usecases.rst
@@ -3,8 +3,9 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) 2015-2017 AT&T Intellectual Property, Inc
 
-Use Cases
-=========
+======================
+OPNFV Copper Use Cases
+======================
 
 Implemented in Current Release
 ------------------------------
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
deleted file mode 100644
index ae6f786..0000000
--- a/docs/userguide/index.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-***********************
-OPNFV Copper User Guide
-***********************
-
-.. toctree::
-   :numbered:
-   :maxdepth: 4
-
-   feature.usage.rst