summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/configguide/abstract.rst4
-rw-r--r--docs/configguide/configoptions.rst4
-rw-r--r--docs/configguide/feature-config.rst7
-rw-r--r--docs/configguide/featureconfig.rst4
-rw-r--r--docs/configguide/index.rst4
-rw-r--r--docs/configguide/installer-config.rst7
-rw-r--r--docs/configguide/installerconfig.rst3
-rw-r--r--docs/configguide/post-install.rst17
-rw-r--r--docs/configguide/postinstall.rst4
-rw-r--r--docs/configguide/projects-configguide.rst8
-rw-r--r--docs/opnfvsecguide/index.rst9
-rw-r--r--docs/templates/LICENSE.rst2
-rw-r--r--docs/templates/index.rst4
-rw-r--r--docs/userguide/abstract.rst4
-rw-r--r--docs/userguide/feature-usage.rst15
-rw-r--r--docs/userguide/general-system.rst21
-rw-r--r--docs/userguide/index.rst5
-rw-r--r--docs/userguide/introduction.rst4
-rw-r--r--docs/userguide/onos.rst4
-rw-r--r--docs/userguide/opendaylight.rst4
-rw-r--r--docs/userguide/openstack.rst4
-rw-r--r--docs/userguide/ovs.rst4
-rw-r--r--docs/userguide/projects-userguide.rst8
-rw-r--r--docs/userguide/test-usage.rst17
-rw-r--r--docs/userguide/userguide.rst5
25 files changed, 145 insertions, 27 deletions
diff --git a/docs/configguide/abstract.rst b/docs/configguide/abstract.rst
index 8005d86dd..95f7628b0 100644
--- a/docs/configguide/abstract.rst
+++ b/docs/configguide/abstract.rst
@@ -1,3 +1,7 @@
+.. 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)
+
========
Abstract
========
diff --git a/docs/configguide/configoptions.rst b/docs/configguide/configoptions.rst
index f977ccf20..720abe275 100644
--- a/docs/configguide/configoptions.rst
+++ b/docs/configguide/configoptions.rst
@@ -1,3 +1,7 @@
+.. 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)
+
=====================
Configuration Options
=====================
diff --git a/docs/configguide/feature-config.rst b/docs/configguide/feature-config.rst
index 1053807ad..60696caf4 100644
--- a/docs/configguide/feature-config.rst
+++ b/docs/configguide/feature-config.rst
@@ -1,3 +1,7 @@
+.. 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
=====================
@@ -5,4 +9,7 @@ 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.
+.. include:: ../projects/copper/configguide/configguide.rst
+.. include:: ../projects/promise/configguide/featureconfig.rst
.. include:: ../projects/sdnvpn/configguide/configguide.rst
+
diff --git a/docs/configguide/featureconfig.rst b/docs/configguide/featureconfig.rst
index 9189902c6..0fe70060e 100644
--- a/docs/configguide/featureconfig.rst
+++ b/docs/configguide/featureconfig.rst
@@ -1,3 +1,7 @@
+.. 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 feature including
diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst
index 9e43a174f..1d042fb99 100644
--- a/docs/configguide/index.rst
+++ b/docs/configguide/index.rst
@@ -1,3 +1,7 @@
+.. 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 Configuration Guide
*************************
diff --git a/docs/configguide/installer-config.rst b/docs/configguide/installer-config.rst
index 00596db92..3d34931f2 100644
--- a/docs/configguide/installer-config.rst
+++ b/docs/configguide/installer-config.rst
@@ -1,3 +1,7 @@
+.. 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
=======================
@@ -5,5 +9,8 @@ Installer Configuration
The following sections describe the per installer configuration options.
Further details for each installer are captured in the referred project documentation.
+.. include:: ../projects/apex/configguide/introduction.rst
+.. include:: ../projects/apex/configguide/baremetal.rst
.. include:: ../projects/fuel/configguide/installerconfig.rst
.. include:: ../projects/joid/configguide/installerconfig.rst
+
diff --git a/docs/configguide/installerconfig.rst b/docs/configguide/installerconfig.rst
index dd4a43330..afb414bf5 100644
--- a/docs/configguide/installerconfig.rst
+++ b/docs/configguide/installerconfig.rst
@@ -1,3 +1,6 @@
+.. 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
=======================
diff --git a/docs/configguide/post-install.rst b/docs/configguide/post-install.rst
index 663080d2a..1a7c4ca53 100644
--- a/docs/configguide/post-install.rst
+++ b/docs/configguide/post-install.rst
@@ -1,9 +1,22 @@
+.. 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
=============================
-This section describes the post configuration activitites that will allow you to validate the success
-of your configuration. Further details may be found in the referred project specific documentation.
+Once you have deployed and configured your scenario and features you should validate the
+state of the system using the following guides.
+
+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:
.. include:: ../projects/functest/configguide/configguide.rst
.. include:: ../projects/joid/configguide/postinstall.rst
+
+The following sections provide information on how to validate the features you have
+installed in your scenario:
+
+.. include:: ../projects/copper/configguide/postinstall.rst
+
diff --git a/docs/configguide/postinstall.rst b/docs/configguide/postinstall.rst
index 1702cea5f..959bb81eb 100644
--- a/docs/configguide/postinstall.rst
+++ b/docs/configguide/postinstall.rst
@@ -1,3 +1,7 @@
+.. 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
diff --git a/docs/configguide/projects-configguide.rst b/docs/configguide/projects-configguide.rst
index b16bfe0fc..71ed0d821 100644
--- a/docs/configguide/projects-configguide.rst
+++ b/docs/configguide/projects-configguide.rst
@@ -1,2 +1,6 @@
-..
- This file will have links to other projects docs in composite doc build.
+.. 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/opnfvsecguide/index.rst b/docs/opnfvsecguide/index.rst
index cac474948..d690a5359 100644
--- a/docs/opnfvsecguide/index.rst
+++ b/docs/opnfvsecguide/index.rst
@@ -18,12 +18,3 @@ Contents:
network
contribution
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
diff --git a/docs/templates/LICENSE.rst b/docs/templates/LICENSE.rst
index 774645389..ed7a4a22b 100644
--- a/docs/templates/LICENSE.rst
+++ b/docs/templates/LICENSE.rst
@@ -1,3 +1,5 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
Copyright 2015 Open Platform for NFV Project, Inc. and its contributors
Open Platform for NFV Project Software Licence
diff --git a/docs/templates/index.rst b/docs/templates/index.rst
index 5fde4e39e..2f124e5c0 100644
--- a/docs/templates/index.rst
+++ b/docs/templates/index.rst
@@ -1,3 +1,7 @@
+.. 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>
+
.. OPNFV Release Engineering documentation, created by
sphinx-quickstart on Tue Jun 9 19:12:31 2015.
You can adapt this file completely to your liking, but it should at least
diff --git a/docs/userguide/abstract.rst b/docs/userguide/abstract.rst
index c2d93b98c..fa9b73669 100644
--- a/docs/userguide/abstract.rst
+++ b/docs/userguide/abstract.rst
@@ -1,3 +1,7 @@
+.. 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)
+
========
Abstract
========
diff --git a/docs/userguide/feature-usage.rst b/docs/userguide/feature-usage.rst
index 8c69694b2..0b23c42eb 100644
--- a/docs/userguide/feature-usage.rst
+++ b/docs/userguide/feature-usage.rst
@@ -1,8 +1,15 @@
+.. 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)
+
==========================
Using Brahmaputra Features
==========================
-This section of the user guide provides feature specific user guides and references.
-This provides user information when leveraging the features in the platform where as a user you may
-need to perform operations, many operation in this section refer to the guides in the general system usage
-section.
+The following sections of the user guide provide feature specific usage guidelines and references.
+Providing users the necessary information to leveraging the features in the platform,
+some operation in this section may refer back to the guides in the general system usage section.
+
+.. include:: ../projects/promise/userguide/userguide.rst
+.. include:: ../projects/copper/userguide/userguide.rst
+
diff --git a/docs/userguide/general-system.rst b/docs/userguide/general-system.rst
index 8920a2519..08d6f19b7 100644
--- a/docs/userguide/general-system.rst
+++ b/docs/userguide/general-system.rst
@@ -1,15 +1,20 @@
-============================
-Usage of platform components
-============================
+.. 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 section of the user guide provides general system component user guides and references.
-This provides user information for common components of the platform where as a user you may
-need to perform operations, depending on the scenario deployed and types of activities you are doing.
+================================
+Using common platform components
+================================
+
+This section outlines basic usage principans and methods for some of the commonly deployed
+components of suported OPNFV scenario's in Brahmaputra.
+The subsections provide an outline of how these components are commonly used and how to address them
+in an OPNFV deployment. The components derive from autonomous upstream communities and where possible
+this guide will provide direction ot the relevant documentation made available by those communities
+to better help you navigate the OPNFV deployment.
.. include:: ./openstack.rst
.. include:: ./opendaylight.rst
.. include:: ./onos.rst
.. include:: ./ovs.rst
-.. include:: ../projects/functest/userguide/description.rst
-.. include:: ../projects/functest/userguide/runfunctest.rst
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
index 6ad11efef..bdc6f221f 100644
--- a/docs/userguide/index.rst
+++ b/docs/userguide/index.rst
@@ -1,3 +1,7 @@
+.. 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 User Guide
****************
@@ -8,4 +12,5 @@ OPNFV User Guide
./abstract
./introduction
./general-system
+ ./test-usage
./feature-usage
diff --git a/docs/userguide/introduction.rst b/docs/userguide/introduction.rst
index c1ab145bc..f2958eea9 100644
--- a/docs/userguide/introduction.rst
+++ b/docs/userguide/introduction.rst
@@ -1,3 +1,7 @@
+.. 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)
+
========
Overview
========
diff --git a/docs/userguide/onos.rst b/docs/userguide/onos.rst
index c68801eaf..66cd1255b 100644
--- a/docs/userguide/onos.rst
+++ b/docs/userguide/onos.rst
@@ -1,3 +1,7 @@
+.. 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)
+
ONOS User Guide
===============
diff --git a/docs/userguide/opendaylight.rst b/docs/userguide/opendaylight.rst
index 6e43c05c5..e6870f34e 100644
--- a/docs/userguide/opendaylight.rst
+++ b/docs/userguide/opendaylight.rst
@@ -1,3 +1,7 @@
+.. 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)
+
OpenDaylight User Guide
=======================
diff --git a/docs/userguide/openstack.rst b/docs/userguide/openstack.rst
index daeb5240f..70a5d6550 100644
--- a/docs/userguide/openstack.rst
+++ b/docs/userguide/openstack.rst
@@ -1,3 +1,7 @@
+.. 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)
+
OpenStack User Guide
====================
diff --git a/docs/userguide/ovs.rst b/docs/userguide/ovs.rst
index 9209ac61c..7c6f576a8 100644
--- a/docs/userguide/ovs.rst
+++ b/docs/userguide/ovs.rst
@@ -1,3 +1,7 @@
+.. 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)
+
OVS User Guide
==============
diff --git a/docs/userguide/projects-userguide.rst b/docs/userguide/projects-userguide.rst
index b16bfe0fc..e82305b7c 100644
--- a/docs/userguide/projects-userguide.rst
+++ b/docs/userguide/projects-userguide.rst
@@ -1,2 +1,6 @@
-..
- This file will have links to other projects docs in composite doc build.
+.. 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)
+
+.. include:: ../projects/promise/userguide/userguide.rst
+
diff --git a/docs/userguide/test-usage.rst b/docs/userguide/test-usage.rst
new file mode 100644
index 000000000..f7e92fd18
--- /dev/null
+++ b/docs/userguide/test-usage.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) Christopher Price (Ericsson AB)
+
+==================================
+Using the test frameworks in OPNFV
+==================================
+
+Testing is one of the key activities in OPNFV, validation can include component level testing,
+system testing, automated deployment validation and performance charecteristics testing.
+
+The following sections outline how to use the test projects delivering automated
+test suites and frameworks in the in the Brahmaputra release of OPNFV.
+
+.. include:: ../projects/functest/userguide/description.rst
+.. include:: ../projects/functest/userguide/runfunctest.rst
+
diff --git a/docs/userguide/userguide.rst b/docs/userguide/userguide.rst
index 7f3e4f904..f133134df 100644
--- a/docs/userguide/userguide.rst
+++ b/docs/userguide/userguide.rst
@@ -1,3 +1,7 @@
+.. 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>
+
<Feature> capabilities and usage
================================
Describe the specific capabilities and usage for <XYZ> feature.
@@ -5,3 +9,4 @@ Describe the specific capabilities and usage for <XYZ> feature.
<Feature and API usage guidelines and example>
-----------------------------------------------
Describe with examples how to use specfic features.
+