Small editorial changes to the template documents.

Added reference sections without local placeholders.
Restructured the user-guide index template.

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

diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst
index 50deb66..8a0f0d5 100644 (file)
--- a/docs/configguide/index.rst
+++ b/docs/configguide/index.rst
@@ -18,10 +18,8 @@ Contents:
 Installer Configuration
 =======================
 
-.. toctree::
-   :maxdepth: 2
-
-   ./installerconfig
+Waiting for the structue in the installer repo's to
+add the include references.
 
 Feature Configuration
 =====================
@@ -31,10 +29,8 @@ Feature Configuration
 Post Configuration Activities
 =============================
 
-.. toctree::
-   :maxdepth: 2
-
-   ./postinstall.rst
+Waiting for the structue in the remote repo's to
+add the include references.
 
 Indices and tables
 ==================

diff --git a/docs/userguide/abstract.rst b/docs/userguide/abstract.rst
new file mode 100644 (file)
index 0000000..b7b22aa
--- /dev/null
+++ b/docs/userguide/abstract.rst
@@ -0,0 +1,8 @@
+Abstract
+--------
+
+This document provides guidance and instructions for using
+features delivered in the Brahmaputra release of OPNFV.
+
+This document provides a guide for the usage of features and the
+needed selection of tools and components as prerequisites.

diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
index c78dd86..6aea808 100644 (file)
--- a/docs/userguide/index.rst
+++ b/docs/userguide/index.rst
@@ -6,15 +6,22 @@
 Welcome to OPNFV User Guide
 ===========================
 
-This guide seeks to inform operators how to use the OPNFV Platform and its components to enable platform
-features provided in the Brahmaputra release.
+.. toctree::
+   :maxdepth: 2
+
+   abstract.rst
+   introduction.rst
 
-Contents:
+General system usage
+====================
 
 .. toctree::
    :maxdepth: 2
 
-   userguide.rst
+   openstack.rst
+   opendaylight.rst
+   onos.rst
+   ovs.rst
 
 Using Brahmaputra Features
 ==========================

diff --git a/docs/userguide/introduction.rst b/docs/userguide/introduction.rst
new file mode 100644 (file)
index 0000000..a492c6e
--- /dev/null
+++ b/docs/userguide/introduction.rst
@@ -0,0 +1,4 @@
+OPNFV User Guide
+================
+
+Outline the structure and composition of the User Guide in this section.

diff --git a/docs/userguide/onos.rst b/docs/userguide/onos.rst
new file mode 100644 (file)
index 0000000..0806caa
--- /dev/null
+++ b/docs/userguide/onos.rst
@@ -0,0 +1,7 @@
+ONOS User Guide
+=======================
+
+Add ONOS specific user guide information here.
+Needs to include OPNFV default ports and addresses and
+references to upstream documentation applicable for an
+OPNFV deployment.

diff --git a/docs/userguide/opendaylight.rst b/docs/userguide/opendaylight.rst
new file mode 100644 (file)
index 0000000..6e43c05
--- /dev/null
+++ b/docs/userguide/opendaylight.rst
@@ -0,0 +1,7 @@
+OpenDaylight User Guide
+=======================
+
+Add opendaylight specific user guide information here.
+Needs to include OPNFV default ports and addresses and
+references to upstream documentation applicable for an
+OPNFV deployment.

diff --git a/docs/userguide/openstack.rst b/docs/userguide/openstack.rst
new file mode 100644 (file)
index 0000000..daeb524
--- /dev/null
+++ b/docs/userguide/openstack.rst
@@ -0,0 +1,7 @@
+OpenStack User Guide
+====================
+
+Add openstack specific user guide information here.
+Needs to include OPNFV default ports and addresses and
+references to upstream documentation applicable for an
+OPNFV deployment.

diff --git a/docs/userguide/ovs.rst b/docs/userguide/ovs.rst
new file mode 100644 (file)
index 0000000..9209ac6
--- /dev/null
+++ b/docs/userguide/ovs.rst
@@ -0,0 +1,7 @@
+OVS User Guide
+==============
+
+Add OVS specific user guide information here.
+Needs to include OPNFV default ports and addresses and
+references to upstream documentation applicable for an
+OPNFV deployment.

diff --git a/docs/userguide/userguide.rst b/docs/userguide/userguide.rst
deleted file mode 100644 (file)
index b129b5d..0000000
--- a/docs/userguide/userguide.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-
-
-OPNFV User Guide
-================
-
-abstact.rst
-
-????????????????
-================
-
-Table of content
-
-introduction.rst
-
-configuration-overview.rst
-
-General system usage
-====================
-Openstack.rst
-Opendaylight.rst
-onos.rst
-xxx.rst
-xxx.rst
-
-Using Brahmaputra features
-==========================
-projectxyz.rst
-
-
-