Update installation.introduction.rst CIRV-SDV and other install/testing edits.
[opnfvdocs.git] / docs / featureprojects.rst
index 6f45f08..56c2f2c 100644 (file)
-OPNFV Projects
-================
-
-ARMband
---------
-.. toctree::
-   :maxdepth: 1
+.. _opnfv-featureprojects:
 
-   ../submodules/armband/docs/release/configguide/index
-   ../submodules/armband/docs/release/installation/index
-   ../submodules/armband/docs/release/userguide/index
-   ../submodules/armband/docs/development/design/index
-   ../submodules/armband/docs/development/manuals/index
-   ../submodules/armband/docs/development/overview/index
-   ../submodules/armband/docs/development/requirements/index
+OPNFV Projects
+==============
 
+Apex
+----
 
-Barometer
-----------
-.. toctree::
-   :maxdepth: 1
+* :doc:`Apex Overview <apex:index>`
+* :doc:`Apex Installation instructions <apex:release/installation/index>`
 
-   ../submodules/barometer/docs/release/configguide/index
-   ../submodules/barometer/docs/release/installation/index
-   ../submodules/barometer/docs/release/userguide/index
-   ../submodules/barometer/docs/development/design/index
-   ../submodules/barometer/docs/development/manuals/index
-   ../submodules/barometer/docs/development/overview/index
-   ../submodules/barometer/docs/development/requirements/index
 
+Availability
+------------
 
-Copper
---------
-.. toctree::
-   :maxdepth: 1
+* :doc:`Availability overview <availability:index>`
+* :doc:`High Availability Requirement Analysis in OPNFV <availability:development/overview/index>`
 
-   ../submodules/copper/docs/release/configguide/index
-   ../submodules/copper/docs/release/installation/index
-   ../submodules/copper/docs/release/userguide/index
-   ../submodules/copper/docs/development/design/index
-   ../submodules/copper/docs/development/manuals/index
-   ../submodules/copper/docs/development/overview/index
-   ../submodules/copper/docs/development/requirements/index
 
+Barometer
+---------
 
-Doctor
---------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/doctor/docs/release/configguide/index
-   ../submodules/doctor/docs/release/installation/index
-   ../submodules/doctor/docs/release/userguide/index
-   ../submodules/doctor/docs/development/design/index
-   ../submodules/doctor/docs/development/manuals/index
-   ../submodules/doctor/docs/development/overview/index
-   ../submodules/doctor/docs/development/requirements/index
-
-Domino
---------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/domino/docs/release/configguide/index
-   ../submodules/domino/docs/release/installation/index
-   ../submodules/domino/docs/release/userguide/index
-   ../submodules/domino/docs/development/design/index
-   ../submodules/domino/docs/development/manuals/index
-   ../submodules/domino/docs/development/overview/index
-   ../submodules/domino/docs/development/requirements/index
-
+* :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>`
 
-IPV6
---------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/ipv6/docs/release/configguide/index
-   ../submodules/ipv6/docs/release/installation/index
-   ../submodules/ipv6/docs/release/userguide/index
-   ../submodules/ipv6/docs/development/design/index
-   ../submodules/ipv6/docs/development/manuals/index
-   ../submodules/ipv6/docs/development/overview/index
-   ../submodules/ipv6/docs/development/requirements/index
-
-
-KVM for NFV
--------------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/kvmfornfv/docs/release/configguide/index
-   ../submodules/kvmfornfv/docs/release/installation/index
-   ../submodules/kvmfornfv/docs/release/userguide/index
-   ../submodules/kvmfornfv/docs/development/design/index
-   ../submodules/kvmfornfv/docs/development/manuals/index
-   ../submodules/kvmfornfv/docs/development/overview/index
-   ../submodules/kvmfornfv/docs/development/requirements/index
-
-
-Moon
+Clover
 ------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/moon/docs/release/configguide/index
-   ../submodules/moon/docs/release/installation/index
-   ../submodules/moon/docs/release/userguide/index
-   ../submodules/moon/docs/development/design/index
-   ../submodules/moon/docs/development/manuals/index
-   ../submodules/moon/docs/development/overview/index
-   ../submodules/moon/docs/development/requirements/index
-
 
-Multisite
-----------
-.. toctree::
-   :maxdepth: 1
+* :doc:`Clover Overview <clover:index>`
 
-   ../submodules/multisite/docs/release/configguide/index
-   ../submodules/multisite/docs/release/installation/index
-   ../submodules/multisite/docs/release/userguide/index
-   ../submodules/multisite/docs/development/design/index
-   ../submodules/multisite/docs/development/manuals/index
-   ../submodules/multisite/docs/development/overview/index
-   ../submodules/multisite/docs/development/requirements/index
+Doctor
+------
 
+* :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>`
 
-Netready
+Edgecloud
 ---------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/netready/docs/release/configguide/index
-   ../submodules/netready/docs/release/installation/index
-   ../submodules/netready/docs/release/userguide/index
-   ../submodules/netready/docs/development/design/index
-   ../submodules/netready/docs/development/manuals/index
-   ../submodules/netready/docs/development/overview/index
-   ../submodules/netready/docs/development/requirements/index
 
-ONOS
--------
-.. toctree::
-   :maxdepth: 1
+* :doc:`Edgecloud Overview <edgecloud:index>`
+* :doc:`Edgecloud Requirements <edgecloud:development/requirements/index>`
 
-   ../submodules/onosfw/docs/installationprocedure/index
-   ../submodules/onosfw/docs/design/index
-   ../submodules/onosfw/docs/userguide/index
-
-
-OVSNFV
---------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/ovsnfv/docs/release/configguide/index
-   ../submodules/ovsnfv/docs/release/installation/index
-   ../submodules/ovsnfv/docs/release/userguide/index
-   ../submodules/ovsnfv/docs/development/design/index
-   ../submodules/ovsnfv/docs/development/manuals/index
-   ../submodules/ovsnfv/docs/development/overview/index
-   ../submodules/ovsnfv/docs/development/requirements/index
-
-
-Parser
---------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/parser/docs/release/configguide/index
-   ../submodules/parser/docs/release/installation/index
-   ../submodules/parser/docs/release/userguide/index
-   ../submodules/parser/docs/development/design/index
-   ../submodules/parser/docs/development/manuals/index
-   ../submodules/parser/docs/development/overview/index
-   ../submodules/parser/docs/development/requirements/index
-
-
-Pharos
---------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/pharos/docs/platformoverview/index
-   ../submodules/pharos/docs/specification/index
-
-
-SDNVPN
---------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/sdnvpn/docs/release-notes/index
-   ../submodules/sdnvpn/docs/userguide/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/release/configguide/index
-   ../submodules/sfc/docs/release/installation/index
-   ../submodules/sfc/docs/release/userguide/index
-   ../submodules/sfc/docs/development/design/index
-   ../submodules/sfc/docs/development/manuals/index
-   ../submodules/sfc/docs/development/overview/index
-   ../submodules/sfc/docs/development/requirements/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>`