Update installation.introduction.rst CIRV-SDV and other install/testing edits.
[opnfvdocs.git] / docs / featureprojects.rst
index 0869149..56c2f2c 100644 (file)
-OPNFV Feature Projects
-=======================
+.. _opnfv-featureprojects:
 
-ARMband
---------
-.. toctree::
-   :maxdepth: 1
+OPNFV Projects
+==============
 
-   ../submodules/armband/docs/releasenotes/index
-   ../submodules/armband/docs/installationprocedure/index
+Apex
+----
 
-Copper
---------
-.. toctree::
-   :maxdepth: 1
+* :doc:`Apex Overview <apex:index>`
+* :doc:`Apex Installation instructions <apex:release/installation/index>`
 
-   ../submodules/copper/docs/design/index
-   ../submodules/copper/docs/releasenotes/index
-   ../submodules/copper/docs/userguide/index
-   ../submodules/copper/docs/installationprocedure/index
 
-Doctor
---------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/doctor/docs/scenario/index
-   ../submodules/doctor/docs/installationprocedure/index
-   ../submodules/doctor/docs/userguide/index
-   ../submodules/doctor/docs/releasenotes/index
-
-Domino
---------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/domino/docs/installationprocedure/index
-   ../submodules/domino/docs/userguide/index
-
-IPV6
---------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/ipv6/docs/userguide/index
-   ../submodules/ipv6/docs/configurationguide/index
-
-KVM for NFV
--------------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/kvmfornfv/docs/userguide/index
-   ../submodules/kvmfornfv/docs/configurationguide/index
-   ../submodules/kvmfornfv/docs/installationprocedure/index
-   ../submodules/kvmfornfv/docs/releasenotes/index
-
-Moon
-------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/moon/docs/userguide/index
-   ../submodules/moon/docs/installationprocedure/index
-   ../submodules/moon/docs/releasenotes/index
-
-Multisite
-------------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/multisite/docs/userguide/index
-   ../submodules/multisite/docs/installationprocedure/index
-   ../submodules/multisite/docs/releasenotes/index
-
-
-Netready
+Availability
 ------------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/netready/docs/requirements/index
-
-
-ONOS
--------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/onosfw/docs/userguide/index
-   ../submodules/onosfw/docs/installationprocedure/index
-
-OVSNFV
---------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/ovsnfv/docs/userguide/index
-   ../submodules/ovsnfv/docs/configguide/index
 
+* :doc:`Availability overview <availability:index>`
+* :doc:`High Availability Requirement Analysis in OPNFV <availability:development/overview/index>`
 
-Parser
---------
-.. toctree::
-   :maxdepth: 1
 
-   ../submodules/parser/docs/userguide/index
-   ../submodules/parser/docs/installationprocedure/index
+Barometer
+---------
 
+* :doc:`Barometer Overview <barometer:index>`
+* :doc:`Barometer Requirements <barometer:development/requirements/index>`
+* :doc:`Barometer Config Guide <barometer:release/configguide/index>`
+* :doc:`Barometer User Guide <barometer:release/userguide/index>`
+* :doc:`Barometer Design Guide <barometer:development/design/index>`
 
-Pharos
---------
-.. toctree::
-   :maxdepth: 1
+Clover
+------
 
-   ../submodules/pharos/docs/specification/index
-   ../submodules/pharos/docs/configguide/index
+* :doc:`Clover Overview <clover:index>`
 
-Promise
---------
-.. toctree::
-   :maxdepth: 1
+Doctor
+------
 
-   ../submodules/promise/docs/requirements/index
-   ../submodules/promise/docs/installationprocedure/index
-   ../submodules/promise/docs/userguide/index
+* :doc:`Doctor overview <doctor:index>`
+* :doc:`Doctor Requirements <doctor:development/requirements/index>`
+* :doc:`Doctor Config Guide <doctor:release/configguide/index>`
+* :doc:`Doctor User Guide <doctor:release/userguide/index>`
+* :doc:`Doctor Design Guide <doctor:development/design/index>`
+* :doc:`OpenStack NOVA API for marking host down <doctor:development/manuals/index>`
 
+Edgecloud
+---------
 
-SDNVPN
---------
-.. toctree::
-   :maxdepth: 1
+* :doc:`Edgecloud Overview <edgecloud:index>`
+* :doc:`Edgecloud Requirements <edgecloud:development/requirements/index>`
 
-   ../submodules/sdnvpn/docs/scenarios/os-odl_l2-bgpvpn/index
-   ../submodules/sdnvpn/docs/userguide/index
-   ../submodules/sdnvpn/docs/release-notes/index
+IPV6
+----
 
+* :doc:`IPV6 Overview <ipv6:index>`
+* :doc:`IPV6 Installation Guide <ipv6:release/installation/index>`
+* :doc:`IPV6 Config Guide <ipv6:release/configguide/index>`
+* :doc:`IPV6 User Guide <ipv6:release/userguide/index>`
 
 SFC
------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/sfc/docs/userguide/index
-   ../submodules/sfc/docs/releasenotes/index
-   ../submodules/sfc/docs/installationprocedure/index
-
-
-Software fast-path quality metrics
-------------------------------------
-.. toctree::
-   :maxdepth: 1
+---
 
-   ../submodules/fastpathmetrics/docs/userguide/index
-   ../submodules/fastpathmetrics/docs/requirements/index
-   ../submodules/fastpathmetrics/docs/configguide/index
+* :doc:`SFC Overview <sfc:index>`
+* :doc:`SFC Requirements <sfc:development/requirements/index>`
+* :doc:`SFC Config Guide <sfc:release/configguide/index>`
+* :doc:`SFC User Guide <sfc:release/userguide/index>`
+* :doc:`SFC Devlopment Guide <sfc:development/design/index>`