diff options
Diffstat (limited to 'docs/documentation/index.rst')
| -rw-r--r-- | docs/documentation/index.rst | 178 |
1 files changed, 120 insertions, 58 deletions
diff --git a/docs/documentation/index.rst b/docs/documentation/index.rst index 1909ed55b..6f3ee54b8 100644 --- 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>`_ + |