summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSofia Wallin <sofia.wallin@ericsson.com>2016-09-22 11:22:13 +0000
committerGerrit Code Review <gerrit@172.30.200.206>2016-09-22 11:22:13 +0000
commit199598501aaf2926fea43ea4cdfe5b2e29c0fd92 (patch)
treebfbeb9bac41cd44e62d01dbd8af640bb18be4ee5
parent22a34c0d46217f7d9d002a0b8979fa2cdd47c1b5 (diff)
parentbfa8d322eb0dbaf79416221df43373e30e0126dd (diff)
Merge "Final Colorado 1.0 update for the release documentation library" into stable/coloradocolorado.1.0
-rw-r--r--docs/documentation/index.rst145
1 files changed, 104 insertions, 41 deletions
diff --git a/docs/documentation/index.rst b/docs/documentation/index.rst
index 1909ed5..d885d8f 100644
--- a/docs/documentation/index.rst
+++ b/docs/documentation/index.rst
@@ -17,8 +17,8 @@ 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 Installation instruction <http://artifacts.opnfv.org/opnfvdocs/colorado/docs/installationprocedure/index.html>`_
+* `OPNFV user guide <http://artifacts.opnfv.org/opnfvdocs/colorado/docs/userguide/index.html>`_
Installation instructions
=========================
@@ -32,115 +32,178 @@ Installation instructions
* `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>`_
-Feature Project documentation
+Feature project documentation
=============================
+---------------
+ARMband project
+---------------
+
+* `Installation instruction <http://artifacts.opnfv.org/armband/colorado/docs/installationprocedure/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/armband/colorado/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/docs/design/index.html>`_
+* `Installation instruction <http://artifacts.opnfv.org/copper/colorado/docs/installationprocedure/index.html>`_
+* `User guide <http://artifacts.opnfv.org/copper/colorado/docs/userguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/copper/colorado/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/docs/platformoverview/index.html>`_
+* `User guide <http://artifacts.opnfv.org/doctor/colorado/docs/userguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/doctor/colorado/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>`_
-------------------------------------------------
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/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/docs/installationprocedure/index.html>`_
+* `User guide <http://artifacts.opnfv.org/ipv6/colorado/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>`_
+* `Installation instruction <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/installationprocedure/index.html>`_
* `Configuration guide <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/configurationguide/index.html>`_
+* `User guide <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/userguide/index.html>`_
* `Release notes <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/releasenotes/index.html>`_
+--------------------------------
+MOON security management for NFV
+--------------------------------
+
+* `Project and Scenario overview <http://artifacts.opnfv.org/moon/colorado/docs/colorado_scenarios_os-odl_l2-moon-ha/index.html>`_
+* `Installation instruction <http://artifacts.opnfv.org/moon/colorado/docs/installationprocedure/index.html>`_
+* `Configuration guide <http://artifacts.opnfv.org/moon/colorado/docs/configurationguide/index.html>`_
+* `User guide <http://artifacts.opnfv.org/moon/colorado/docs/userguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/moon/colorado/docs/releasenotes/index.html>`_
+
+----------------------------
+Multisite datacenter project
+----------------------------
+
+* `Installation instruction <http://artifacts.opnfv.org/multisite/colorado/installationprocedure/index.html>`_
+* `User guide <http://artifacts.opnfv.org/multisite/colorado/userguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/multisite/colorado/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/docs/requirements/index.html>`_
----------------------
ONOS framework project
----------------------
-* `Installation guide <http://artifacts.opnfv.org/onosfw/colorado/docs/installationprocedure/index.html>`_
+* `Installation instruction <http://artifacts.opnfv.org/onosfw/colorado/docs/installationprocedure/index.html>`_
* `User guide <http://artifacts.opnfv.org/onosfw/colorado/docs/userguide/index.html>`_
----------------------------
OVSNFV release documentation
----------------------------
+* `OVS for NFV scenario description <http://artifacts.opnfv.org/ovsnfv/colorado/docs/scenarios_os-nosdn-ovs/index.html>`_
* `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>`_
--------------
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>`_
+* `Installation instruction <http://artifacts.opnfv.org/parser/colorado/docs/installationprocedure/index.html>`_
* `User guide <http://artifacts.opnfv.org/parser/colorado/docs/userguide/index.html>`_
-Test Project documentation
-==========================
+------
+Pharos
+------
-----------------------
-Functest documentation
-----------------------
+* `Pharos specification <http://artifacts.opnfv.org/pharos/colorado/docs/specification/index.html>`_
+* `Configuration guide <http://artifacts.opnfv.org/pharos/colorado/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/docs/requirements/index.html>`_
+* `Installation and configuration guide <http://artifacts.opnfv.org/promise/colorado/docs/installationprocedure/index.html>`_
+* `User guide <http://artifacts.opnfv.org/promise/colorado/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/docs/scenarios_os-odl_l2-bgpvpn/index.html>`_
+* `User guide <http://artifacts.opnfv.org/sdnvpn/colorado/docs/userguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/sdnvpn/colorado/docs/release-notes/index.html>`_
-* `Release and development documentation <http://artifacts.opnfv.org/vswitchperf/colorado/docs/index.html>`_
+---
+SFC
+---
+
+* `Design documentation <http://artifacts.opnfv.org/sfc/colorado/docs/design/index.html>`_
+* `SFC scenario description <http://artifacts.opnfv.org/sfc/colorado/docs/scenarios_os-odl_l2-sfc-noha/index.html>`_
+* `High availability SFC scenario description <http://artifacts.opnfv.org/sfc/colorado/docs/scenarios_os-odl_l2-sfc-ha/index.html>`_
+* `Installation instruction <http://artifacts.opnfv.org/sfc/colorado/docs/installationprocedure/index.html>`_
+* `User guide <http://artifacts.opnfv.org/sfc/colorado/docs/userguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/sfc/colorado/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/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/docs/installationprocedure/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/bottlenecks/docs/releasenotes/index.html>`_
+
+----------------------
+Functest documentation
+----------------------
+
+* `Configuration guide <http://artifacts.opnfv.org/functest/colorado/docs/configguide/index.html>`_
+* `User guide <http://artifacts.opnfv.org/functest/colorado/docs/userguide/index.html>`_
+* `Developer guide <http://artifacts.opnfv.org/functest/colorado/docs/devguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/functest/colorado/docs/release-notes/functest-release.html>`_
+
+-------------------------
+vSwitchPerf documentation
+-------------------------
+
+* `Release and development documentation <http://artifacts.opnfv.org/vswitchperf/colorado/docs/index.html>`_
+
+-----------------------
+Yardstick documentation
+-----------------------
+
+* `User guide <http://artifacts.opnfv.org/yardstick/colorado/docs/userguide/index.html>`_
+* `Release notes <http://artifacts.opnfv.org/yardstick/colorado/docs/release/index.html>`_
+