Merge "Add figure for Testing Ecosystem"

diff --git a/INFO b/INFO
index e1848c0..87798d0 100644 (file)
--- a/INFO
+++ b/INFO
@@ -12,10 +12,9 @@ Repository: opnfvdocs
 
 Committers:
 christopher.price@ericsson.com
-wenjing_chu@dell.com
+chu.wenjing@gmail.com
 fatih.degirmenci@ericsson.com
 Iben.Rodriguez@spirent.com
-vlaza@cloudbasesolutions.com
 r-mibu@cq.jp.nec.com
 sofia.wallin@ericsson.com
 

diff --git a/docs/documentation/index.rst b/docs/documentation/index.rst
index 1909ed5..6f3ee54 100644 (file)
--- a/docs/documentation/index.rst
+++ b/docs/documentation/index.rst
@@ -16,131 +16,193 @@ more detailed installation instructions and descriptive documentation.
 Platform documentation
 ======================
 
-* `OPNFV platform overview document <http://artifacts.opnfv.org/opnfvdocs/colorado/docs/overview/index.html>`_
-* `Installation & configuration guide <http://artifacts.opnfv.org/opnfvdocs/colorado/docs/installationprocedure/index.html>`_
-* `The OPNFV user guide <http://artifacts.opnfv.org/opnfvdocs/colorado/docs/userguide/index.html>`_
+* `OPNFV platform overview document <http://artifacts.opnfv.org/opnfvdocs/colorado/2.0/docs/overview/index.html>`_
+* `OPNFV Installation instruction <http://artifacts.opnfv.org/opnfvdocs/colorado/2.0/docs/installationprocedure/index.html>`_
+* `OPNFV user guide <http://artifacts.opnfv.org/opnfvdocs/colorado/2.0/docs/userguide/index.html>`_
 
 Installation instructions
 =========================
 
-* `Apex installation instruction <http://artifacts.opnfv.org/apex/colorado/docs/installationprocedure/index.html>`_
-* `Apex release notes <http://artifacts.opnfv.org/apex/colorado/docs/releasenotes/index.html>`_
-* `Compass installation instruction <http://artifacts.opnfv.org/compass4nfv/colorado/docs/installationprocedure/index.html>`_
-* `Compass release notes <http://artifacts.opnfv.org/compass4nfv/colorado/docs/releasenotes/index.html>`_
-* `Fuel installation instruction <http://artifacts.opnfv.org/fuel/colorado/docs/installationprocedure/index.html>`_
-* `Fuel release notes <http://artifacts.opnfv.org/fuel/colorado/docs/releasenotes/index.html>`_
-* `Joid installation instruction <http://artifacts.opnfv.org/joid/colorado/docs/installationprocedure/index.html>`_
-* `Joid release notes <http://artifacts.opnfv.org/joid/colorado/docs/releasenotes/index.html>`_
+* `Apex installation instruction <http://artifacts.opnfv.org/apex/colorado/2.0/docs/installationprocedure/index.html>`_
+* `Apex release notes <http://artifacts.opnfv.org/apex/colorado/2.0/docs/releasenotes/index.html>`_
+* `Compass installation instruction <http://artifacts.opnfv.org/compass4nfv/colorado/2.0/docs/installationprocedure/index.html>`_
+* `Compass release notes <http://artifacts.opnfv.org/compass4nfv/colorado/2.0/docs/releasenotes/index.html>`_
+* `Fuel installation instruction <http://artifacts.opnfv.org/fuel/colorado/2.0/docs/installationprocedure/index.html>`_
+* `Fuel release notes <http://artifacts.opnfv.org/fuel/colorado/2.0/docs/releasenotes/index.html>`_
+* `Joid installation instruction <http://artifacts.opnfv.org/joid/colorado/2.0/docs/installationprocedure/index.html>`_
+* `Joid release notes <http://artifacts.opnfv.org/joid/colorado/2.0/docs/releasenotes/index.html>`_
 
-Feature Project documentation
+Feature project documentation
 =============================
 
+---------------
+ARMband project
+---------------
+
+* `Installation instruction <http://artifacts.opnfv.org/armband/colorado/2.0/docs/installationprocedure/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/armband/colorado/2.0/docs/releasenotes/index.html>`_
+
 ----------------------------------------------
-Copper, policy features, release documentation
+Copper release documentation
 ----------------------------------------------
 
-* `Copper release documentation <http://artifacts.opnfv.org/copper/colorado/docs/design/index.html>`_
+* `Design documentation <http://artifacts.opnfv.org/copper/colorado/2.0/docs/design/index.html>`_
+* `Installation instruction <http://artifacts.opnfv.org/copper/colorado/2.0/docs/installationprocedure/index.html>`_
+* `User guide <http://artifacts.opnfv.org/copper/colorado/2.0/docs/userguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/copper/colorado/2.0/docs/releasenotes/index.html>`_
 
 -----------------------------------------------------
-Doctor, fault notification, features and capabilities
+Doctor features and capabilities
 -----------------------------------------------------
 
-* `The doctor overview document <http://artifacts.opnfv.org/doctor/colorado/docs/platformoverview/index.html>`_
-* `Doctor user guide <http://artifacts.opnfv.org/doctor/colorado/docs/userguide/index.html>`_
+* `Project overview <http://artifacts.opnfv.org/doctor/colorado/2.0/docs/scenarios/index.html>`_
+* `User guide <http://artifacts.opnfv.org/doctor/colorado/2.0/docs/userguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/doctor/colorado/2.0/docs/releasenotes/index.html>`_
 
 ----------------------------------------------------------------
-Domino, template distribution service, features and capabilities
+Domino features and capabilities
 ----------------------------------------------------------------
 
-* `User guide <http://artifacts.opnfv.org/domino/colorado/docs/userguide/index.html>`_
-* `Configuration guide <http://artifacts.opnfv.org/domino/colorado/docs/configguide/index.html>`_
+* `User guide <http://artifacts.opnfv.org/domino/colorado/2.0/docs/userguide/index.html>`_
 
 -------------------------------------------------
 FastDataStacks feature and scenario documentation
 -------------------------------------------------
 
-* `OpenDaylight integrated fd.io scenario description <http://artifacts.opnfv.org/fds/colorado/docs/scenarios_os-odl_l2-fdio-noha/index.html>`_
+* `OpenDaylight integrated fd.io scenario description <http://artifacts.opnfv.org/fds/colorado/2.0/scenarios_os-odl_l2-fdio-noha/index.html>`_
 
 ------------------------------------
 IPv6 platform support and capability
 ------------------------------------
 
-* `IPv6 user guide <http://artifacts.opnfv.org/ipv6/colorado/docs/userguide/index.html>`_
-* `Installation of routing functions <http://artifacts.opnfv.org/ipv6/colorado/docs/reldoc/index.html>`_
+* `Configuration guide <http://artifacts.opnfv.org/ipv6/colorado/2.0/docs/installationprocedure/index.html>`_
+* `User guide <http://artifacts.opnfv.org/ipv6/colorado/2.0/docs/userguide/index.html>`_
 
 -----------
 KVM for NFV
 -----------
 
-* `Installation guide <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/installationprocedure/index.html>`_
-* `User guide <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/userguide/index.html>`_
-* `Configuration guide <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/configurationguide/index.html>`_
-* `Release notes <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/releasenotes/index.html>`_
+* `Installation instruction <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/installationprocedure/index.html>`_
+* `Configuration guide <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/configurationguide/index.html>`_
+* `User guide <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/userguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/releasenotes/index.html>`_
+
+--------------------------------
+MOON security management for NFV
+--------------------------------
+
+* `Project and Scenario overview <http://artifacts.opnfv.org/moon/colorado/docs/scenarios_os-odl_l2-moon-ha/index.html>`_
+* `Installation instruction <http://artifacts.opnfv.org/moon/colorado/2.0/docs/installationprocedure/index.html>`_
+* `User guide <http://artifacts.opnfv.org/moon/colorado/2.0/docs/userguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/moon/colorado/2.0/docs/releasenotes/index.html>`_
+
+----------------------------
+Multisite datacenter project
+----------------------------
+
+* `Installation instruction <http://artifacts.opnfv.org/multisite/colorado/2.0/docs/installationprocedure/index.html>`_
+* `User guide <http://artifacts.opnfv.org/multisite/colorado/2.0/docs/userguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/multisite/colorado/2.0/docs/releasenotes/index.html>`_
 
 -------------------------
 Network readiness project
 -------------------------
 
-* `Network readiness report <http://artifacts.opnfv.org/netready/colorado/docs/requirements/index.html>`_
+* `Requirements document <http://artifacts.opnfv.org/netready/colorado/2.0/docs/requirements/index.html>`_
 
 ----------------------
 ONOS framework project
 ----------------------
 
-* `Installation guide <http://artifacts.opnfv.org/onosfw/colorado/docs/installationprocedure/index.html>`_
-* `User guide <http://artifacts.opnfv.org/onosfw/colorado/docs/userguide/index.html>`_
+* `Installation instruction <http://artifacts.opnfv.org/onosfw/colorado/2.0/docs/installationprocedure/index.html>`_
+* `User guide <http://artifacts.opnfv.org/onosfw/colorado/2.0/docs/userguide/index.html>`_
 
 ----------------------------
 OVSNFV release documentation
 ----------------------------
 
-* `Configuration guide <http://artifacts.opnfv.org/ovsnfv/colorado/docs/configguide/index.html>`_
-* `User guide <http://artifacts.opnfv.org/ovsnfv/colorado/docs/userguide/index.html>`_
-* `Release notes <http://artifacts.opnfv.org/ovsnfv/colorado/docs/release/index.html>`_
-* `OVS for NFV scenario description <http://artifacts.opnfv.org/ovsnfv/colorado/docs/scenarios_os-nosdn-ovs/index.html>`_
+* `OVS for NFV scenario description <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/scenarios_os-nosdn-ovs/index.html>`_
+* `Configuration guide <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/configguide/index.html>`_
+* `User guide <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/userguide/index.html>`_
 
 --------------
 Parser project
 --------------
 
-* `Parser release documentation <http://artifacts.opnfv.org/parser/colorado/docs/parser_docs/index.html>`_
-* `Installation guide <http://artifacts.opnfv.org/parser/colorado/docs/installationprocedure/index.html>`_
-* `User guide <http://artifacts.opnfv.org/parser/colorado/docs/userguide/index.html>`_
+* `Parser release documentation <http://artifacts.opnfv.org/parser/colorado/2.0/docs/parser_docs/index.html>`_
+* `Installation instruction <http://artifacts.opnfv.org/parser/colorado/2.0/docs/installationprocedure/index.html>`_
+* `User guide <http://artifacts.opnfv.org/parser/colorado/2.0/docs/userguide/index.html>`_
 
-Test Project documentation
-==========================
+------
+Pharos
+------
 
-----------------------
-Functest documentation
-----------------------
+* `Pharos specification <http://artifacts.opnfv.org/pharos/colorado/2.0/docs/specification/index.html>`_
+* `Configuration guide <http://artifacts.opnfv.org/pharos/colorado/2.0/docs/configguide/index.html>`_
 
-*  `The Functest configuration guide <http://artifacts.opnfv.org/functest/colorado/docs/configguide/index.html>`_
-*  `The Functest user Guide <http://artifacts.opnfv.org/functest/colorado/docs/userguide/index.html>`_
-*  `A developer guide for working with functest <http://artifacts.opnfv.org/functest/colorado/docs/devguide/index.html>`_
-*  `Functest release Notes <http://artifacts.opnfv.org/functest/colorado/docs/release-notes/functest-release.html>`_
+-------
+Promise
+-------
 
------------------------
-Yardstick documentation
------------------------
+* `Requirement specification <http://artifacts.opnfv.org/promise/colorado/2.0/docs/requirements/index.html>`_
+* `Installation and configuration guide <http://artifacts.opnfv.org/promise/colorado/2.0/docs/installationprocedure/index.html>`_
+* `User guide <http://artifacts.opnfv.org/promise/colorado/2.0/docs/userguide/index.html>`_
 
-*  `The Yardstick user guide <http://artifacts.opnfv.org/yardstick/colorado/docs/userguide/index.html>`_
-*  `A code documentation and developer guide <http://artifacts.opnfv.org/yardstick/colorado/docs/apidocs/index.html>`_
-*  `Yardstick release notes <http://artifacts.opnfv.org/yardstick/colorado/docs/release/index.html>`_
+------
+SDNVPN
+------
 
--------------------------
-vSwitchPerf documentation
--------------------------
+* `BGPVPN scenario description <http://artifacts.opnfv.org/sdnvpn/colorado/2.0/docs/scenarios_os-odl_l2-bgpvpn/index.html>`_
+* `User guide <http://artifacts.opnfv.org/sdnvpn/colorado/2.0/docs/userguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/sdnvpn/colorado/2.0/docs/release-notes/index.html>`_
+
+---
+SFC
+---
 
-* `Release and development documentation  <http://artifacts.opnfv.org/vswitchperf/colorado/docs/index.html>`_
+* `Design documentation <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/design/index.html>`_
+* `SFC scenario description <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/scenarios_os-odl_l2-sfc-noha/index.html>`_
+* `High availability SFC scenario description <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/scenarios_os-odl_l2-sfc-ha/index.html>`_
+* `Installation instruction <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/installationprocedure/index.html>`_
+* `User guide <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/userguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/releasenotes/index.html>`_
 
 ------------------------------------------------
 Software fast-path quality metrics documentation
 ------------------------------------------------
 
-* `Release and development documentation <http://artifacts.opnfv.org/fastpathmetrics/colorado/docs/index.html>`_
+* `Release and development documentation <http://artifacts.opnfv.org/fastpathmetrics/colorado/2.0/index.html>`_
+
+
+Test Project documentation
+==========================
 
 -------------------------
 Bottlenecks documentation
 -------------------------
 
-* `Installation procedure <http://artifacts.opnfv.org/bottlenecks/colorado/docs/installationprocedure/index.html>`_
+* `Installation instruction <http://artifacts.opnfv.org/bottlenecks/colorado/2.0/docs/installationprocedure/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/bottlenecks/colorado/2.0/docs/releasenotes/index.html>`_
+
+----------------------
+Functest documentation
+----------------------
+
+*  `Configuration guide <http://artifacts.opnfv.org/functest/colorado/2.0/docs/configguide/index.html>`_
+*  `User guide <http://artifacts.opnfv.org/functest/colorado/2.0/docs/userguide/index.html>`_
+*  `Developer guide <http://artifacts.opnfv.org/functest/colorado/2.0/docs/devguide/index.html>`_
+*  `Release notes <http://artifacts.opnfv.org/functest/colorado/docs/release-notes/index.html>`_
+
+-------------------------
+vSwitchPerf documentation
+-------------------------
+
+* `Release and development documentation  <http://artifacts.opnfv.org/vswitchperf/colorado/2.0/docs/index.html>`_
+
+-----------------------
+Yardstick documentation
+-----------------------
+
+*  `User guide <http://artifacts.opnfv.org/yardstick/colorado/2.0/docs/userguide/index.html>`_
+*  `Release notes <http://artifacts.opnfv.org/yardstick/colorado/2.0/docs/release/index.html>`_
+

diff --git a/docs/installationprocedure/installation.introduction.rst b/docs/installationprocedure/installation.introduction.rst
index ae4a601..201112c 100644 (file)
--- a/docs/installationprocedure/installation.introduction.rst
+++ b/docs/installationprocedure/installation.introduction.rst
@@ -26,7 +26,7 @@ it is important to understand your required target platform capabilities before
 configuring your target scenario.
 
 An OPNFV installation requires either a physical, or virtual, infrastructure environment as defined
-in the `Pharos specification <http://artifacts.opnfv.org/pharos/colorado/docs/specification/index.html>`_.
+in the `Pharos specification <http://artifacts.opnfv.org/pharos/colorado/2.0/docs/specification/index.html>`_.
 When configuring a physical infrastructure it is strongly advised to follow the Pharos configuration guidelines.
 
 =========
@@ -42,13 +42,14 @@ where each scenario will include different source components or configurations.
 To learn more about the scenarios supported in the Colorado release refer to the scenario
 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>`_
-- 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 OVS `os-nosdn-ovs <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/scenarios_os-nosdn-ovs/index.html>`_
+- Layer 3 overlay using opendaylight `os-odl-l2-bgpvpn <http://artifacts.opnfv.org/sdnvpn/colorado/2.0/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/2.0/scenarios_os-odl_l2-fdio-noha/index.html>`_
+- High availability service function chaining `os-odl-l2-sfc-ha <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/scenarios_os-odl_l2-sfc-ha/index.html>`_
+- Service function chaining `os-odl-l2-sfc-noha <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/scenarios_os-odl_l2-sfc-noha/index.html>`_
+- Accelerated KVM hypervisor `os-nosdn-kvm-ha <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/scenarios_os-nosdn-kvm-ha/index.html>`_
+- LXD container hypervisor `os-nosdn-lxd-noha <http://artifacts.opnfv.org/joid/colorado/2.0/docs/scenarios_os-nosdn-lxd-noha/index.html>`_
+- High Availability LXD container hypervisor `os-nosdn-lxd-ha <http://artifacts.opnfv.org/joid/colorado/2.0/docs/scenarios_os-nosdn-lxd-ha/index.html>`_
 
 ======================
 Installation Procedure
@@ -60,10 +61,10 @@ support for the OPNFV Colorado release are; Apex, Compass4nfv, Fuel and Joid.
 
 The instructions for each toolchain can be found in these links:
 
-- `Apex installation instruction <http://artifacts.opnfv.org/apex/colorado/docs/installationprocedure/index.html>`_
-- `Compass4nfv installation instruction <http://artifacts.opnfv.org/compass4nfv/colorado/docs/installationprocedure/index.html>`_
-- `Fuel installation instruction <http://artifacts.opnfv.org/fuel/colorado/docs/installationprocedure/index.html>`_
-- `Joid installation instruction <http://artifacts.opnfv.org/joid/colorado/docs/installationprocedure/index.html>`_
+- `Apex installation instruction <http://artifacts.opnfv.org/apex/colorado/2.0/docs/installationprocedure/index.html>`_
+- `Compass4nfv installation instruction <http://artifacts.opnfv.org/compass4nfv/colorado/2.0/docs/installationprocedure/index.html>`_
+- `Fuel installation instruction <http://artifacts.opnfv.org/fuel/colorado/2.0/docs/installationprocedure/index.html>`_
+- `Joid installation instruction <http://artifacts.opnfv.org/joid/colorado/2.0/docs/installationprocedure/index.html>`_
 
 =====================
 OPNFV Test Frameworks
@@ -77,8 +78,27 @@ select the right test suites to run on your platform from the available projects
 
 Many of the OPNFV test project provide user-guide documentation and installation instructions as provided below:
 
-- `Functest user guide <http://artifacts.opnfv.org/functest/colorado/docs/userguide/index.html>`_
-- `Yardstick user guide <http://artifacts.opnfv.org/yardstick/colorado/docs/userguide/index.html>`_
-- `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>`_
+- `Functest user guide <http://artifacts.opnfv.org/functest/colorado/2.0/docs/userguide/index.html>`_
+- `Yardstick user guide <http://artifacts.opnfv.org/yardstick/colorado/2.0/docs/userguide/index.html>`_
+- `vSwitchPerf user guide <http://artifacts.opnfv.org/vswitchperf/colorado/2.0/index.html>`_
+- `Software Fastpath Service Quality Metrics (SFQM) user guide <http://artifacts.opnfv.org/fastpathmetrics/colorado/2.0/index.html>`_
+- `Bottlenecks user guide <http://artifacts.opnfv.org/bottlenecks/colorado/2.0/docs/installationprocedure/index.html>`_
+- `Storage Performance Benchmarking for NFVI (StorPerf) user guide <http://artifacts.opnfv.org/storperf/colorado/2.0/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/overview/overview.rst b/docs/overview/overview.rst
index fd10fd4..cd1b5d0 100644 (file)
--- a/docs/overview/overview.rst
+++ b/docs/overview/overview.rst
@@ -109,7 +109,7 @@ composition may vary depending on the installer and scenario.
 
 For details on the scenarios available in OPNFV and the specific composition of components
 refer to the OPNFV installation instruction:
-https://artifacts.opnfv.org/opnfvdocs/colorado/docs/installationprocedure/index.rst
+http://artifacts.opnfv.org/opnfvdocs/colorado/2.0/docs/installationprocedure/index.html
 
 -----------------
 Operating Systems
@@ -165,7 +165,7 @@ A typical OPNFV deployment starts with three controller nodes running in a high
 configuration including control plane components from OpenStack, SDN, etc. and a minimum
 of two compute nodes for deployment of workloads (VNFs).
 A detailed description of the hardware requirements required to support the 5 node configuration
-can be found in pharos specification: https://artifacts.opnfv.org/pharos/colorado/docs/specification/index.rst
+can be found in pharos specification: http://artifacts.opnfv.org/pharos/colorado/2.0/docs/specification/index.html
 
 In addition to the deployment on a highly available physical infrastructure, OPNFV can be
 deployed for development and lab purposes in a virtual environment.  In this case each of the hosts
@@ -221,7 +221,7 @@ Functest
 Functest provides a functional testing framework incorporating a number of test suites
 and test cases that test and verify OPNFV platform functionality.
 The scope of Functest and relevant test cases can be found in its
-`user guide <http://artifacts.opnfv.org/functest/colorado/docs/userguide/index.html>`_.
+`user guide <http://artifacts.opnfv.org/functest/colorado/2.0/docs/userguide/index.html>`_.
 
 Functest provides both feature project and component test suite integration, leveraging
 OpenStack and SDN controllers testing frameworks to verify the key components of the OPNFV
@@ -285,7 +285,6 @@ Bottlenecks provides a framework to find system limitations and bottlenecks, pro
 root cause isolation capabilities to facilitate system evaluation.
 
 
-.. _`OPNFV Configuration Guide`: http://artifacts.opnfv.org/opnfvdocs/colorado/docs/configguide
-.. _`OPNFV User Guide`: http://artifacts.opnfv.org/opnfvdocs/colorado/docs/userguide
+.. _`OPNFV Configuration Guide`: http://artifacts.opnfv.org/opnfvdocs/colorado/2.0/docs/configguide
+.. _`OPNFV User Guide`: http://artifacts.opnfv.org/opnfvdocs/colorado/2.0/docs/userguide
 .. _Dovetail project: https://wiki.opnfv.org/display/dovetail
-

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..48112e7 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:
 
-- `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>`_
-- `SDNVPN user guide <http://artifacts.opnfv.org/sdnvpn/colorado/docs/userguide/index.html>`_
+Feature Configuration Guides
+============================
+
+- `Armband configuration guide <http://artifacts.opnfv.org/armband/colorado/2.0/docs/installationprocedure/index.html>`_
+- `Copper configuration guide <http://artifacts.opnfv.org/copper/colorado/2.0/docs/installationprocedure/index.html>`_
+- `Doctor configuration guide <http://artifacts.opnfv.org/doctor/colorado/2.0/docs/installationprocedure/index.html>`_
+- `IPv6 configuration guide <http://artifacts.opnfv.org/ipv6/colorado/2.0/docs/installationprocedure/index.html>`_
+- `KVMforNFV configuration guide <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/installationprocedure/index.html>`_
+- `Moon configuration guide <http://artifacts.opnfv.org/moon/colorado/2.0/docs/installationprocedure/index.html>`_
+- `Multisite configuration guide <http://artifacts.opnfv.org/multisite/colorado/2.0/docs/installationprocedure/index.html>`_
+- `ONOSFW configuration guide <http://artifacts.opnfv.org/onosfw/colorado/2.0/installationprocedure/index.html>`_
+- `OVSNFV configuration guide <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/configguide/index.html>`_
+- `Promise configuration guide <http://artifacts.opnfv.org/promise/colorado/2.0/docs/installationprocedure/index.html>`_
+- `SFC configuration guide <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/installationprocedure/index.html>`_
+
+
+Feature User Guides
+===================
+
+- `Copper user guide <http://artifacts.opnfv.org/copper/colorado/2.0/docs/userguide/index.html>`_
+- `Doctor user guide <http://artifacts.opnfv.org/doctor/colorado/2.0/docs/userguide/index.html>`_
+- `Domino user guide <http://artifacts.opnfv.org/domino/colorado/2.0/docs/userguide/index.html>`_
+- `IPv6 user guide <http://artifacts.opnfv.org/ipv6/colorado/2.0/docs/userguide/index.html>`_
+- `KVMforNFV user guide <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/userguide/index.html>`_
+- `Moon user guide <http://artifacts.opnfv.org/moon/colorado/2.0/docs/userguide/index.html>`_
+- `Multisite user guide <http://artifacts.opnfv.org/multisite/colorado/2.0/docs/userguide/index.html>`_
+- `ONOSFW user guide <http://artifacts.opnfv.org/onosfw/colorado/2.0/docs/userguide/index.html>`_
+- `OVSNFV user guide <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/userguide/index.html>`_
+- `Parser user guide <http://artifacts.opnfv.org/parser/colorado/2.0/docs/userguide/index.html>`_
+- `Promise user guide <http://artifacts.opnfv.org/promise/colorado/2.0/docs/userguide/index.html>`_
+- `SDNVPN user guide <http://artifacts.opnfv.org/sdnvpn/colorado/2.0/docs/userguide/index.html>`_
+- `SFC user guide <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/userguide/index.html>`_

diff --git a/scripts/docs-build.sh b/scripts/docs-build.sh
index 466219f..0483fce 100755 (executable)
--- a/scripts/docs-build.sh
+++ b/scripts/docs-build.sh
@@ -26,6 +26,18 @@ opnfv_logo="$OPNFVDOCS_DIR/etc/opnfv-logo.png"
 copyright="$(date +%Y), OPNFV."
 copyrightlong="$(date +%Y), OPNFV. Licenced under CC BY 4.0."
 
+if [ "$(uname)" == "Darwin" ]; then
+  # Override system $SED/$FIND with gnu $SED and gnu $FIND
+  # If not found, install with
+  # $ brew install gnu-sed findutils
+  echo "macOS detected."
+  SED="gsed"
+  FIND="gfind"
+else
+  SED="sed"
+  FIND="find"
+fi
+
 function check_rst_doc() {
     _src="$1"
 
@@ -34,7 +46,7 @@ function check_rst_doc() {
     #       check right now, but these have to be fixed before OPNFV B release.
     _out=$(doc8 --max-line-length 240 --ignore D000 "$_src") || {
         _msg='Warning: rst validation (doc8) has failed, please fix the following error(s).'
-        _errs=$(echo "$_out" | sed -n -e "/^$_src/s/^/    /p")
+        _errs=$(echo "$_out" | $SED -n -e "/^$_src/s/^/    /p")
         echo
         echo -e "$_msg\n$_errs"
         echo
@@ -47,7 +59,7 @@ function check_rst_doc() {
 function add_html_notes() {
     _src="$1"
 
-    find "$_src" -name '*.rst' | while read file
+    $FIND "$_src" -name '*.rst' | while read file
     do
         if grep -q -e ' _sha1_' "$file" ; then
             # TODO: remove this, once old templates were removed from all repos.
@@ -55,9 +67,9 @@ function add_html_notes() {
             echo "Warn: '_sha1_' was found in [$file], use the latest document template."
             echo "      See http://artifacts.opnfv.org/opnfvdocs/docs/how-to-use-docs ."
             echo
-            sed -i "s/ _sha1_/ $git_sha1/g" "$file"
+            $SED -i "s/ _sha1_/ $git_sha1/g" "$file"
         fi
-        sed -i -e "\$a\\\n..\n$html_notes" "$file"
+        $SED -i -e "\$a\\\n..\n$html_notes" "$file"
     done
 }
 
@@ -122,7 +134,7 @@ function prepare_config() {
 
     echo "sphinx config to be used:"
     echo
-    sed -e "s/^/    /" "$_conf"
+    $SED -e "s/^/    /" "$_conf"
     echo
 }
 
@@ -139,7 +151,7 @@ function generate_name_for_top_dir() {
         return
     done
 
-    echo "Error: cannot find name for top directory [$DOCS_DIR]"
+    echo "Error: cannot $FIND name for top directory [$DOCS_DIR]"
     exit 1
 }
 
@@ -186,7 +198,7 @@ if [ -e "$DOCS_DIR/pre-hook.sh" ]; then
     source "$DOCS_DIR/pre-hook.sh"
 fi
 
-find $DOCS_DIR -name $INDEX_RST -printf '%h\n' | while read dir
+$FIND $DOCS_DIR -name $INDEX_RST -printf '%h\n' | while read dir
 do
     name=$(generate_name $dir)
     if is_top_dir "$dir" ; then
@@ -228,8 +240,8 @@ do
         #       docs directory.
         (
             cd $output
-            find . -type d -print | xargs -I d mkdir -p ../d
-            find . -type f -print | xargs -I f mv -b f ../f
+            $FIND . -type d -print | xargs -I d mkdir -p ../d
+            $FIND . -type f -print | xargs -I f mv -b f ../f
         )
         rm -rf "$output"
     fi