Final version

Fixed trailing whitespaces

Added StorPerf, this should prob the last link to add.
Adding more document links.
Added security notes
Added numbering to the user guide
Adding the feature configuration parts to the user guide.

Change-Id: I2b1569c97507be18bd0ec17fab41eeb2554726e5
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
(cherry picked from commit e56ae5e33cfb724e05c34f4e0f9e558659b4d8bf)

diff --git a/docs/installationprocedure/installation.introduction.rst b/docs/installationprocedure/installation.introduction.rst
index ae4a601..5b907bd 100644 (file)
--- a/docs/installationprocedure/installation.introduction.rst
+++ b/docs/installationprocedure/installation.introduction.rst
@@ -43,12 +43,11 @@ To learn more about the scenarios supported in the Colorado release refer to the
 description documents provided:
 
 - Accelerated OVS `os-nosdn-ovs <http://artifacts.opnfv.org/ovsnfv/colorado/docs/scenarios_os-nosdn-ovs/index.html>`_
-- FD.io based forwarding `os-nosdn-fdio-noha <http://artifacts.opnfv.org/fds/docs/scenarios_os-nosdn-fdio-noha/index.html>`_
-- Layer 3 overlay using opendaylight `os-odl-l2-bgpvpn <http://artifacts.opnfv.org/bgpvpn/colorado/docs/scenarios_os-odl_l2-bgpvpn/index.html>`_
+- Layer 3 overlay using opendaylight `os-odl-l2-bgpvpn <http://artifacts.opnfv.org/sdnvpn/colorado/docs/scenarios_os-odl_l2-bgpvpn/index.html>`_
 - FD.io based forwarding using opendaylight SDN `os-odl-12-fdio-noha <http://artifacts.opnfv.org/fds/colorado/scenarios_os-odl_l2-fdio-noha/index.html>`_
 - High availability service function chaining `os-odl-l2-sfc-ha <http://artifacts.opnfv.org/sfc/colorado/docs/scenarios_os-odl_l2-sfc-ha/index.html>`_
 - Service function chaining `os-odl-l2-sfc-noha <http://artifacts.opnfv.org/sfc/colorado/docs/scenarios_os-odl_l2-sfc-noha/index.html>`_
-- `os-odl-l2-moon-ha <http://artifacts.opnfv.org/moon/colorado/docs/senarios/os-odl_l2-moon-ha/index.html>`_
+- Accelerated KVM hypervisor `os-nosdn-kvm-ha <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/scenarios_os-nosdn-kvm-ha-single/index.html>`_
 
 ======================
 Installation Procedure
@@ -82,3 +81,23 @@ Many of the OPNFV test project provide user-guide documentation and installation
 - `vSwitchPerf user guide <http://artifacts.opnfv.org/vswitchperf/colorado/index.html>`_
 - `Software Fastpath Service Quality Metrics (SFQM) user guide <http://artifacts.opnfv.org/fastpathmetrics/colorado/index.html>`_
 - `Bottlenecks user guide <http://artifacts.opnfv.org/bottlenecks/colorado/docs/installationprocedure/index.html>`_
+- `Storage Performance Benchmarking for NFVI (StorPerf) user guide <http://artifacts.opnfv.org/storperf/colorado/docs/userguide/index.html>`_
+
+==============
+Security Notes
+==============
+
+The following patches were applied to fix security issues discovered in opnfv
+projects, during the c-release cycle.
+
+- `Removal of private keys: <https://gerrit.opnfv.org/gerrit/#/c/21995/>`_
+- `Fix security issues of eval-s in testapi: <https://gerrit.opnfv.org/gerrit/#/c/20751/>`_
+- `Implements use of yaml.safe_load: <https://gerrit.opnfv.org/gerrit/#/c/20911/>`_
+- `Fix security issues reported by the security audit: <https://gerrit.opnfv.org/gerrit/#/c/20693/>`_
+- `Fix issues found in security review: <https://gerrit.opnfv.org/gerrit/#/c/21541/>`_
+- `Removing OpenSteak Project: <https://gerrit.opnfv.org/gerrit/#/c/22139/>`_
+- `Remove unsed files in open-contrail role: <https://gerrit.opnfv.org/gerrit/#/c/21997/>`_
+- `Get rid of private key in repo: <https://gerrit.opnfv.org/gerrit/#/c/21985>`_
+- `Handling file loads and tmp dirs differently <https://gerrit.opnfv.org/gerrit/#/c/21499>`_
+- `Remove `Debug = True when run Flask and add logger <https://gerrit.opnfv.org/gerrit/#/c/21799/>`_
+

diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
index baa4ae0..faa5dbd 100644 (file)
--- a/docs/userguide/index.rst
+++ b/docs/userguide/index.rst
@@ -7,6 +7,7 @@ OPNFV User Guide
 ****************
 
 .. toctree::
+   :numbered:
    :maxdepth: 2
 
    ./userguide.introduction.rst

diff --git a/docs/userguide/userguide.introduction.rst b/docs/userguide/userguide.introduction.rst
index 1ab6b84..9e8ae3e 100644 (file)
--- a/docs/userguide/userguide.introduction.rst
+++ b/docs/userguide/userguide.introduction.rst
@@ -41,7 +41,7 @@ projects in the Colorado release. Each of the participating projects provides
 detailed descriptions about the delivered features. Including use cases,
 implementation and configuration specifics on a per OPNFV project basis.
 
-The following are User Guides and assume that the reader has already some
+The following are Configuration Guides and User Guides and assume that the reader has already some
 information about a given projects specifics and deliverables. These guides
 are intended to be used following the installation of a given OPNFV installer
 to allow a user to deploy and implement feature delivered by OPNFV.
@@ -51,8 +51,35 @@ OPNFV projects home page, found on http://wiki.opnfv.org, for specific details.
 
 You can find project specific usage and configuration information below:
 
+Feature Configuration Guides
+============================
+
+- `Armband configuration guide <http://artifacts.opnfv.org/armband/colorado/docs/installationprocedure/index.html>`_
+- `Copper configuration guide <http://artifacts.opnfv.org/copper/colorado/docs/installationprocedure/index.html>`_
+- `Doctor configuration guide <http://artifacts.opnfv.org/doctor/colorado/docs/installationprocedure/index.html>`_
+- `IPv6 configuration guide <http://artifacts.opnfv.org/ipv6/colorado/docs/installationprocedure/index.html>`_
+- `KVMforNFV configuration guide <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/installationprocedure/index.html>`_
+- `Moon configuration guide <http://artifacts.opnfv.org/moon/colorado/docs/installationprocedure/index.html>`_
+- `Multisite configuration guide <http://artifacts.opnfv.org/multisite/colorado/installationprocedure/index.html>`_
+- `ONOSFW configuration guide <http://artifacts.opnfv.org/onosfw/colorado/installationprocedure/index.html>`_
+- `OVSNFV configuration guide <http://artifacts.opnfv.org/ovsnfv/colorado/docs/configguide-single/index.html>`_
+- `Promise configuration guide <http://artifacts.opnfv.org/promise/colorado/docs/installationprocedure/index.html>`_
+- `SFC configuration guide <http://artifacts.opnfv.org/sfc/colorado/docs/installationprocedure/index.html>`_
+
+
+Feature User Guides
+===================
+
+- `Copper user guide <http://artifacts.opnfv.org/copper/colorado/docs/userguide/index.html>`_
+- `Doctor user guide <http://artifacts.opnfv.org/doctor/colorado/docs/userguide/index.html>`_
+- `Domino user guide <http://artifacts.opnfv.org/domino/docs/userguide/index.html>`_
 - `IPv6 user guide <http://artifacts.opnfv.org/ipv6/colorado/docs/userguide/index.html>`_
-- `Multisite user guide <http://artifacts.opnfv.org/multisite/colorado/docs/userguide/index.html>`_
-- `Domino user guide <http://artifacts.opnfv.org/domino/colorado/docs/userguide.index.html>`_
-- `Moon user guide <http://artifacts.opnfv.org/moon/colorado/docs/userguide.html>`_
+- `KVMforNFV user guide <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/userguide-single/index.html>`_
+- `Moon user guide <http://artifacts.opnfv.org/moon/colorado/docs/userguide/index.html>`_
+- `Multisite user guide <http://artifacts.opnfv.org/multisite/colorado/userguide/index.html>`_
+- `ONOSFW user guide <http://artifacts.opnfv.org/onosfw/colorado/userguide/index.html>`_
+- `OVSNFV user guide <http://artifacts.opnfv.org/ovsnfv/colorado/docs/userguide-single/index.html>`_
+- `Parser user guide <http://artifacts.opnfv.org/parser/colorado/docs/userguide/index.html>`_
+- `Promise user guide <http://artifacts.opnfv.org/promise/colorado/docs/userguide/index.html>`_
 - `SDNVPN user guide <http://artifacts.opnfv.org/sdnvpn/colorado/docs/userguide/index.html>`_
+- `SFC user guide <http://artifacts.opnfv.org/sfc/colorado/docs/userguide/index.html>`_