OPNFV Documentation
*******************
-=====================
-Release Documentation
-=====================
+==============================
+Colorado Release Documentation
+==============================
OPNFV release documentation is structured with brief platform-level documents referencing
more detailed installation instructions and descriptive documentation.
Platform documentation
======================
-* `OPNFV platform overview document <http://artifacts.opnfv.org/opnfvdocs/docs/overview/index.html>`_
-* `Installation & configuration guide <http://artifacts.opnfv.org/opnfvdocs/docs/installationprocedure/index.html>`_
-* `The OPNFV user guide <http://artifacts.opnfv.org/opnfvdocs/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/docs/installationprocedure/index.html>`_
-* `Apex release notes <http://artifacts.opnfv.org/apex/docs/releasenotes/index.html>`_
-* `Compass installation instruction <http://artifacts.opnfv.org/compass4nfv/docs/installationprocedure/index.html>`_
-* `Compass release notes <http://artifacts.opnfv.org/compass4nfv/docs/releasenotes/index.html>`_
-* `Fuel installation instruction <http://artifacts.opnfv.org/fuel/docs/installationprocedure/index.html>`_
-* `Fuel release notes <http://artifacts.opnfv.org/fuel/docs/releasenotes/index.html>`_
-* `Joid installation instruction <http://artifacts.opnfv.org/joid/docs/installationprocedure/index.html>`_
-* `Joid release notes <http://artifacts.opnfv.org/joid/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/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/docs/platformoverview/index.html>`_
-* `Doctor user guide <http://artifacts.opnfv.org/doctor/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/docs/userguide/index.html>`_
-* `Configuration guide <http://artifacts.opnfv.org/domino/docs/configguide/index.html>`_
+* `User guide <http://artifacts.opnfv.org/domino/colorado/2.0/docs/userguide/index.html>`_
-------------------------------------------------
FastDataStacks feature and scenario documentation
-------------------------------------------------
-* `Neutron integrated fd.io scenario description <http://artifacts.opnfv.org/fds/docs/scenarios_os-nosdn-fdio-noha/index.html>`_
-* `OpenDaylight integrated fd.io scenario description <http://artifacts.opnfv.org/fds/docs/scenarios_os-odl_l2-fdio-noha/index.html>`_
-
----------------------------------------
-High Availability in the OPNFV platform
----------------------------------------
-
-Needs to be confirmed where the HA docs will come from.
-
-* `High availability scenarios <https://wiki.opnfv.org/download/attachments/2926157/scenario_analysis_for_high_availability_in_nfv.pdf?version=1&modificationDate=1458849162000&api=v2>`_
-* `Platform needs for supporting high availability <https://wiki.opnfv.org/download/attachments/2926157/releases_brahmaputra_ha_requirement.pdf?version=1&modificationDate=1458849162000&api=v2>`_
-
+* `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/docs/userguide/index.html>`_
-* `Installation of routing functions <http://artifacts.opnfv.org/ipv6/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/docs/installationprocedure/index.html>`_
-* `User guide <http://artifacts.opnfv.org/kvmfornfv/docs/userguide/index.html>`_
-* `Configuration guide <http://artifacts.opnfv.org/kvmfornfv/docs/configurationguide/index.html>`_
-* `Release notes <http://artifacts.opnfv.org/kvmfornfv/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/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/docs/installationprocedure/index.html>`_
-* `User guide <http://artifacts.opnfv.org/onosfw/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/docs/configguide/index.html>`_
-* `User guide <http://artifacts.opnfv.org/ovsnfv/docs/userguide/index.html>`_
-* `Release notes <http://artifacts.opnfv.org/ovsnfv/docs/release/index.html>`_
-* `OVS for NFV scenario description <http://artifacts.opnfv.org/ovsnfv/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/docs/parser_docs/index.html>`_
-* `Installation guide <http://artifacts.opnfv.org/parser/docs/installationprocedure/index.html>`_
-* `User guide <http://artifacts.opnfv.org/parser/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/docs/configguide/index.html>`_
-* `The Functest user Guide <http://artifacts.opnfv.org/functest/docs/userguide/index.html>`_
-* `A developer guide for working with functest <http://artifacts.opnfv.org/functest/docs/devguide/index.html>`_
-* `Functest release Notes <http://artifacts.opnfv.org/functest/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/docs/userguide/index.html>`_
-* `A code documentation and developer guide <http://artifacts.opnfv.org/yardstick/docs/apidocs/index.html>`_
-* `Yardstick release notes <http://artifacts.opnfv.org/yardstick/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/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/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/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>`_
+
Code Review / opnfvdocs.git / blobdiff