Establishing document structures for Colorado.

Derived from converging patches 16165, 16047 & 15937 into one patch.

Change-Id: I3c544ba2fa30856a50274bad9342a06eebc39d58
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
Co-Authored-By: Sofia Wallin <sofia.wallin@ericsson.com>

32 files changed, 110 insertions, 235 deletions

diff --git a/docs/configguide/feature-config.rst b/docs/configguide/feature-config.rst
deleted file mode 100644
index f40bff22c..000000000
--- a/docs/configguide/feature-config.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) Christopher Price (Ericsson AB)
-
-=====================
-Feature Configuration
-=====================
-
-The following sections describe the configuration options for specific platform features provided in Brahmaputra.
-Further details for each feature are captured in the referred project documentation.
-
-.. <project>/docs/configguide/featureconfig.rst files will be imported below by the build script.
diff --git a/docs/configguide/installer-config.rst b/docs/configguide/installer-config.rst
deleted file mode 100644
index a88d1f50e..000000000
--- a/docs/configguide/installer-config.rst
+++ /dev/null
@@ -1,21 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) Christopher Price (Ericsson AB)
-
-=======================
-Installer Configuration
-=======================
-
-Installing the OPNFV platform requires either a physical environment as defined in the
-Pharos lab specification, or a virtual infrastructure.  When configuring a physical infrastructure
-it is strongly advised to follow the Pharos configuration material.
-
-.. toctree::
-
-    pharos-config
-
-
-The following sections describe the per installer configuration options.
-Further details for each installer are captured in the referred project documentation.
-
-.. <project>/docs/configguide/installerconfig.rst files will be imported below by the build script.
diff --git a/docs/configguide/installerconfig.rst b/docs/configguide/installerconfig.rst
deleted file mode 100644
index afb414bf5..000000000
--- a/docs/configguide/installerconfig.rst
+++ /dev/null
@@ -1,26 +0,0 @@
-.. 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>
-
-<Project> configuration
-=======================
-Add a brief introduction to configure OPNFV with this specific installer
-
-Pre-configuration activities
------------------------------
-Describe specific pre-configuration activities. Refer to Installations guide and release notes
-
-Hardware configuration
------------------------
-Describe the hardware configuration needed for this specific installer
-
-Jumphost configuration
------------------------
-Describe intial Jumphost configuration (network and software)needed in order to deploy the installer
-
-Platform components configuration
----------------------------------
-Describe the configuration of each component in the installer
-
-
-
diff --git a/docs/configguide/pharos-config.rst b/docs/configguide/pharos-config.rst
deleted file mode 100644
index 013e21b34..000000000
--- a/docs/configguide/pharos-config.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-.. include:: ../projects/pharos/configguide/configguide.rst
-.. include:: ../projects/pharos/configguide/jumpserverinstall.rst
diff --git a/docs/configguide/post-install.rst b/docs/configguide/post-install.rst
deleted file mode 100644
index c7bc27ea1..000000000
--- a/docs/configguide/post-install.rst
+++ /dev/null
@@ -1,59 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) Christopher Price (Ericsson AB)
-
-=============================
-Post Configuration Activities
-=============================
-
-Once you have deployed and configured your scenario and features you should validate the
-state of the system using the following guides.
-
-Scenario validation activities
-==============================
-
-The following guides provide information on how to validate the installation of you scenario
-based on the tools and test suites available for the installation tool you have selected:
-
-.. toctree::
-
-    postinstall-fuel
-
-.. toctree::
-
-    postinstall-joid
-
-Feature validation activities
-=============================
-
-The following sections provide information on how to validate the features you have
-installed in your scenario:
-
-.. toctree::
-
-    postinstall-copper
-
-.. toctree::
-
-    postinstall-ipv6
-
-
-Additional testing and validation activities
-============================================
-
-Many of our testing tools can be manually installed to facilitate targeted testing
-of features and capabilities of your scenario.  The following guides provide instruction on
-setting up these testing suites:
-
-.. toctree::
-
-    postinstall-functest
-
-.. toctree::
-
-    postinstall-vswitchperf
-
-.. toctree::
-
-    postinstall-yardstick
-
diff --git a/docs/configguide/postinstall-copper.rst b/docs/configguide/postinstall-copper.rst
deleted file mode 100644
index 06c4b151b..000000000
--- a/docs/configguide/postinstall-copper.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-.. include:: ../projects/copper/configguide/postinstall.rst
diff --git a/docs/configguide/postinstall-fuel.rst b/docs/configguide/postinstall-fuel.rst
deleted file mode 100644
index 877e548cb..000000000
--- a/docs/configguide/postinstall-fuel.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-.. include:: ../projects/fuel/configguide/postinstall.rst
diff --git a/docs/configguide/postinstall-functest.rst b/docs/configguide/postinstall-functest.rst
deleted file mode 100644
index 5c9e03ec3..000000000
--- a/docs/configguide/postinstall-functest.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-.. include:: ../projects/functest/userguide/introduction.rst
-.. include:: ../projects/functest/configguide/configguide.rst
diff --git a/docs/configguide/postinstall-ipv6.rst b/docs/configguide/postinstall-ipv6.rst
deleted file mode 100644
index 8a51452b6..000000000
--- a/docs/configguide/postinstall-ipv6.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-.. include:: ../projects/ipv6/configguide/postinstall.rst
diff --git a/docs/configguide/postinstall-joid.rst b/docs/configguide/postinstall-joid.rst
deleted file mode 100644
index d986b6f22..000000000
--- a/docs/configguide/postinstall-joid.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-.. include:: ../projects/joid/configguide/postinstall.rst
diff --git a/docs/configguide/postinstall-vswitchperf.rst b/docs/configguide/postinstall-vswitchperf.rst
deleted file mode 100644
index e241d4978..000000000
--- a/docs/configguide/postinstall-vswitchperf.rst
+++ /dev/null
@@ -1,4 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-.. include:: ../projects/vswitchperf/configguide/installation.rst
diff --git a/docs/configguide/postinstall-yardstick.rst b/docs/configguide/postinstall-yardstick.rst
deleted file mode 100644
index 841b47ff1..000000000
--- a/docs/configguide/postinstall-yardstick.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-.. include:: ../projects/yardstick/userguide/comp-intro.rst
-.. include:: ../projects/yardstick/userguide/03-installation.rst
-
diff --git a/docs/configguide/postinstall.rst b/docs/configguide/postinstall.rst
deleted file mode 100644
index 959bb81eb..000000000
--- a/docs/configguide/postinstall.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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>
-
-<Project> post installation procedures
-======================================
-Add a brief introduction to the methods of validating the installation
-according to this specific installer or feature.
-
-Automated post installation activities
---------------------------------------
-Describe specific post installation activities performed by the OPNFV
-deployment pipeline including testing activities and reports. Refer to
-the relevant testing guides, results, and release notes.
-
-note: this section should be singular and derived from the test projects
-once we have one test suite to run for all deploy tools.  This is not the
-case yet so each deploy tool will need to provide (hopefully very simillar)
-documentation of this.
-
-<Project> post configuration procedures
---------------------------------------
-Describe any deploy tool or feature specific scripts, tests or procedures
-that should be carried out on the deployment post install and configuration
-in this section.
-
-Platform components validation
----------------------------------
-Describe any component specific validation procedures necessary for your
-deployment tool in this section.
diff --git a/docs/configguide/projects-configguide.rst b/docs/configguide/projects-configguide.rst
deleted file mode 100644
index 71ed0d821..000000000
--- a/docs/configguide/projects-configguide.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) Christopher Price (Ericsson AB)
-
-..  This file will have links to other projects docs in composite doc build.
-
diff --git a/docs/configguide/abstract.rst b/docs/configurationguide/abstract.rst
index 95f7628b0..1263dfa56 100644
--- a/docs/configguide/abstract.rst
+++ b/docs/configurationguide/abstract.rst
@@ -6,13 +6,14 @@
 Abstract
 ========
 
-This document provides guidance and instructions for the configuration
-of the Brahmaputra release of OPNFV.
+This document provides guidance for the configurations available in the
+Colorado release of OPNFV.
 
 The release includes four installer tools leveraging different
 technologies; Apex, Compass4nfv, Fuel and JOID, which deploy
 components of the platform.
 
-This document provides a guide for the selection of tools and
+This document also includes the selection of tools and
 components including guidelines for how to deploy and configure
 the platform to an operational state.
+
diff --git a/docs/configguide/configoptions.rst b/docs/configurationguide/configuration.options.render.rst
index cb5774a41..f8f16ff54 100644
--- a/docs/configguide/configoptions.rst
+++ b/docs/configurationguide/configuration.options.render.rst
@@ -13,7 +13,7 @@ components such as OpenStack, OpenDaylight, OVS, KVM etc. where each scenario wi
 include different source components or configurations.
 
 OPNFV Scenarios
-================
+===============
 
 Each OPNFV scenario provides unique features and capabilities, it is important to understand
 your target platform capabilities before installing and configuring your target scenario.
diff --git a/docs/configguide/featureconfig.rst b/docs/configurationguide/feature.configuration.description.rst
index 0fe70060e..717cd0fa2 100644
--- a/docs/configguide/featureconfig.rst
+++ b/docs/configurationguide/feature.configuration.description.rst
@@ -1,9 +1,10 @@
 .. 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>
+.. (c) Sofia Wallin (Ericsson AB)
+
+Configuration of <feature>
+==========================
 
-<Project> configuration
-=======================
 Add a brief introduction to configure OPNFV with this specific feature including
 dependancies on platform components, this description should be at a level that
 will apply to any installer providing the pre-requisite components.
@@ -19,10 +20,3 @@ Hardware configuration
 ----------------------
 Describe the hardware configuration needed for this specific feature
 
-Feature configuration
----------------------
-Describe the procedures to configure your feature on the platform in order
-that it is ready to use according to the feature instructions in the platform
-user guide.  Where applicable you should add content in the postinstall.rst
-to validate the feature is configured for use.
-(checking components are installed correctly etc...)
diff --git a/docs/configguide/index.rst b/docs/configurationguide/index.rst
index 1559fab0a..1b0fec4ce 100644
--- a/docs/configguide/index.rst
+++ b/docs/configurationguide/index.rst
@@ -10,8 +10,7 @@ OPNFV Configuration Guide
    :maxdepth: 2
 
    ./abstract
-   ./configoptions
-   ./installer-config
-   ./feature-config
-   ./post-install
+   ./configuration.options.render
+   ./feature.configuration.description
+   ./installer.procedure.render
 
diff --git a/docs/configurationguide/installation.procedure.render.rst b/docs/configurationguide/installation.procedure.render.rst
new file mode 100644
index 000000000..c0925c507
--- /dev/null
+++ b/docs/configurationguide/installation.procedure.render.rst
@@ -0,0 +1,20 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Sofia Wallin (Ericsson AB)
+
+=====================
+Installation of <xxx>
+=====================
+
+Introduction
+------------
+Describe the capabilities and associated features of each installer.
+
+Pre-installation activities
+---------------------------
+List the acitvites needed for pre-installation.
+
+Hardware requirement
+--------------------
+List the HW requirement for each installer
+
diff --git a/docs/installationprocedure/abstract.rst b/docs/installationprocedure/abstract.rst
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/docs/installationprocedure/abstract.rst
diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst
new file mode 100644
index 000000000..9503c7b50
--- /dev/null
+++ b/docs/installationprocedure/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) Sofia Wallin Ericsson AB
+
+**********************
+Installation procedure
+**********************
+
+.. toctree::
+   :numbered:
+   :maxdepth: 2
+
+   abstract.rst
+   scenario.installation.instruction
+
diff --git a/docs/installationprocedure/scenario.installation.instruction.rst b/docs/installationprocedure/scenario.installation.instruction.rst
new file mode 100644
index 000000000..a3ddd3ac8
--- /dev/null
+++ b/docs/installationprocedure/scenario.installation.instruction.rst
@@ -0,0 +1,26 @@
+.. 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>
+
+===================================
+<scenario> installation instruction
+===================================
+
+Preparing the installation
+--------------------------
+.. List the activities needed prior to installation and dependent feature configurations that
+.. need to be is to be configured during this process.
+
+HW requirements
+---------------
+.. A generic Pharos lab preparation instruction will be provided, this section should describe
+.. scenario has any specific hardware or hardware configuration needs.
+
+Installation instruction
+------------------------
+.. List of steps needed to install each verified installer.
+
+Post-installation activities
+----------------------------
+.. List the activities needed post installation.
+
diff --git a/docs/release-notes/release-notes.rst b/docs/installationprocedure/scenario.release.notes.rst
index 545e1d9bf..545e1d9bf 100644
--- a/docs/release-notes/release-notes.rst
+++ b/docs/installationprocedure/scenario.release.notes.rst
diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst
deleted file mode 100644
index c8cad46f4..000000000
--- a/docs/release-notes/index.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-.. 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/testframework/framework.installation.procedure.render.rst b/docs/testframework/framework.installation.procedure.render.rst
new file mode 100644
index 000000000..8eaa57d12
--- /dev/null
+++ b/docs/testframework/framework.installation.procedure.render.rst
@@ -0,0 +1,10 @@
+.. 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>
+
+<test framework> preparation and installation
+=============================================
+
+.. Explain how to prepare for and install the test framework.
+..  Need to identify the target structure of this document with the testing WG
+
diff --git a/docs/testframework/framework.userguide.render.rst b/docs/testframework/framework.userguide.render.rst
new file mode 100644
index 000000000..3f9993c13
--- /dev/null
+++ b/docs/testframework/framework.userguide.render.rst
@@ -0,0 +1,10 @@
+.. 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>
+
+<test framework> userguide and reporting document
+=================================================
+
+.. Explain how to use the test framework and read reports/results.
+..  Need to identify the target structure of this document with the testing WG
+
diff --git a/docs/testframework/index.rst b/docs/testframework/index.rst
new file mode 100644
index 000000000..16521c141
--- /dev/null
+++ b/docs/testframework/index.rst
@@ -0,0 +1,16 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Christopher Price (Ericsson AB)
+
+*****************************
+OPNFV Test Framework document
+*****************************
+
+.. toctree::
+   :maxdepth: 2
+
+   ./abstract
+   ./opnfv.testframework.overview
+   ./framework.installation.procedure.render
+   ./framework.userguide.render
+
diff --git a/docs/userguide/test-usage.rst b/docs/testframework/opnfv.testframework.overview.rst
index 423a3069d..92cc88685 100644
--- a/docs/userguide/test-usage.rst
+++ b/docs/testframework/opnfv.testframework.overview.rst
@@ -13,5 +13,5 @@ The following section outlines how to use the test projects that are delivered o
 OPNFV platform for the purpose of testing components and VNFs in the context of a
 Brahmaputra deployment.
 
-.. <project>/docs/userguide/testusage.rst files will be imported below by the build script.
+Needs to be completed according to the testing WG needs.
 
diff --git a/docs/userguide/general-system.rst b/docs/userguide/common.platform.render.rst
index 1235c8f77..1235c8f77 100644
--- a/docs/userguide/general-system.rst
+++ b/docs/userguide/common.platform.render.rst
diff --git a/docs/userguide/feature-usage.rst b/docs/userguide/feature.userguide.render.rst
index fa1186dc6..fa1186dc6 100644
--- a/docs/userguide/feature-usage.rst
+++ b/docs/userguide/feature.userguide.render.rst
diff --git a/docs/userguide/featureusage.rst b/docs/userguide/feature.userguide.template.rst
index f133134df..f133134df 100644
--- a/docs/userguide/featureusage.rst
+++ b/docs/userguide/feature.userguide.template.rst
diff --git a/docs/userguide/testusage.rst b/docs/userguide/testusage.rst
deleted file mode 100644
index 9f9bdc9de..000000000
--- a/docs/userguide/testusage.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-.. 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>
-
-<Testing> capabilities and usage
-================================
-Describe the specific capabilities and usage for <XYZ> testing.
-
-<Testing usage guidelines and example>
---------------------------------------
-Describe with examples how to use specfic test frameworks.
-