Adding template files for the configguide composite document

Added the feature configuration and post install/config template files for use in the composite configguide document.
Fixed trailing whitespace, and added ./ specificity to the local doc references.

Change-Id: I7778993d01d978b60d46375b334d59dbdc2b855a
Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>

diff --git a/docs/configguide/abstract.rst b/docs/configguide/abstract.rst
index ddade55..608ad06 100644 (file)
--- a/docs/configguide/abstract.rst
+++ b/docs/configguide/abstract.rst
@@ -1,11 +1,13 @@
-
-
 Abstract
 --------
 
-This document desribes how to configure the Brahmaputra release of OPNFV.
-The release includes four installers Apex, Compass4nfv, Fuel and JOID.
+This document provides guidance and instructions for the configuration
+of the Brahmaputra release of OPNFV.
 
-Intended for *******
+The release includes four installer tools leveraging different
+technologies; Apex, Compass4nfv, Fuel and JOID, which deploy
+components of the platform.
 
-We write something about the doc for the title page.
+This document provides a guide for 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/featureconfig.rst b/docs/configguide/featureconfig.rst
new file mode 100644 (file)
index 0000000..9189902
--- /dev/null
+++ b/docs/configguide/featureconfig.rst
@@ -0,0 +1,24 @@
+<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.
+
+Pre-configuration activities
+----------------------------
+Describe specific pre-configuration activities. This should include ensuring the
+right components are installed by the installation tools as required for your
+feature to function.  Refer to the previous installer configuration chapters,
+installations guide and release notes
+
+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/configguide/index.rst
index a3db3fb..9cf7bae 100644 (file)
--- a/docs/configguide/index.rst
+++ b/docs/configguide/index.rst
@@ -6,31 +6,40 @@
 OPNFV Configuration Guide
 =========================
 
-    abstract.rst
-
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
-
-   introduction.rst
-   configoptions.rst
+   ./abstract
+   ./introduction
+   ./configoptions
 
 Installer Configuration
 =======================
 
-   installerconfig.rst
+.. toctree::
+   :maxdepth: 2
+
+   ./installerconfig
 
 
 Feature Configuration
 =====================
+
+.. toctree::
+   :maxdepth: 2
+
    ../../sdnvpn/docs/configguide/configguide.rst
 
 
 Post Configuration Activities
 =============================
 
+.. toctree::
+   :maxdepth: 2
+
+   ./postinstall.rst
 
 Indices and tables
 ==================

diff --git a/docs/configguide/introduction.rst b/docs/configguide/introduction.rst
index 7d904d2..058514e 100644 (file)
--- a/docs/configguide/introduction.rst
+++ b/docs/configguide/introduction.rst
@@ -1,11 +1,10 @@
-
 Scope
 =====
 
 
 Using this guide
 ----------------
-
+This section is probably wrong as we should dive straight into this, we have an abstract already.
 
 Pre-requisites
 --------------

diff --git a/docs/configguide/postinstall.rst b/docs/configguide/postinstall.rst
new file mode 100644 (file)
index 0000000..1702cea
--- /dev/null
+++ b/docs/configguide/postinstall.rst
@@ -0,0 +1,26 @@
+<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.