Fix Calipso link on index
[opnfvdocs.git] / docs / featureprojects.rst
index d158220..447f816 100644 (file)
-OPNFV Projects
-================
-
-ARMband
---------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/armband/docs/installationprocedure/index
-
-Barometer
-----------
-.. toctree::
-   :maxdepth: 1
+.. _opnfv-featureprojects:
 
-   ../submodules/barometer/docs/release/configguide/index
-   ../submodules/barometer/docs/release/userguide/index
+OPNFV Projects
+==============
 
+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/userguide/index
-   ../submodules/copper/docs/installationprocedure/index
-
-Doctor
---------
-.. toctree::
-   :maxdepth: 1
+Armband
+-------
 
-   ../submodules/doctor/docs/scenario/index
-   ../submodules/doctor/docs/installationprocedure/index
-   ../submodules/doctor/docs/userguide/index
+* :doc:`Armband Overview <armband:index>`
+* :doc:`Armband Installation <armband:release/installation/index>`
+* :doc:`Fuel User Guide <armband:release/userguide/index>`
 
-Domino
---------
-.. toctree::
-   :maxdepth: 1
 
-   ../submodules/domino/docs/installationprocedure/index
-   ../submodules/domino/docs/userguide/index
+Availability
+------------
 
-IPV6
---------
-.. toctree::
-   :maxdepth: 1
+* :doc:`Availability overview <availability:index>`
+* :doc:`High Availability Requirement Analysis in OPNFV <availability:development/overview/index>`
 
-   ../submodules/ipv6/docs/userguide/index
-   ../submodules/ipv6/docs/configurationguide/index
 
-KVM for NFV
--------------
-.. toctree::
-   :maxdepth: 1
+Barometer
+---------
 
-   ../submodules/kvmfornfv/docs/userguide/index
-   ../submodules/kvmfornfv/docs/configurationguide/index
-   ../submodules/kvmfornfv/docs/installationprocedure/index
-   ../submodules/kvmfornfv/docs/releasenotes/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>`
 
-Moon
+Clover
 ------
-.. 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
+* :doc:`Clover Overview <clover:index>`
 
+Compass4Nfv
+-----------
 
-Netready
-------------
-.. toctree::
-   :maxdepth: 1
+* :doc:`Compass4nfv Overview <compass4nfv:index>`
+* :doc:`Compass4nfv Installation <compass4nfv:release/installation/index>`
+* :doc:`Compass4nfv Design Guide <compass4nfv:development/design/index>`
 
-   ../submodules/netready/docs/requirements/index
+Daisy4NFV
+---------
 
+* :doc:`Daisy overview <daisy:index>`
+* :doc:`Daisy Design Guide <daisy:development/design/index>`
+* :doc:`Daisy Config Guide <daisy:release/configguide/index>`
+* :doc:`Daisy Installation Guide <daisy:release/installation/index>`
 
-ONOS
--------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/onosfw/docs/userguide/index
-   ../submodules/onosfw/docs/installationprocedure/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>`
 
-OpenRetriever
--------------
+Edgecloud
+---------
 
+* :doc:`Edgecloud Overview <edgecloud:index>`
+* :doc:`Edgecloud Requirements <edgecloud:development/requirements/index>`
 
-OVSNFV
---------
-.. toctree::
-   :maxdepth: 1
+IPV6
+----
 
-   ../submodules/ovsnfv/docs/userguide/index
-   ../submodules/ovsnfv/docs/configguide/index
+* :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>`
 
 
 Parser
---------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/parser/docs/userguide/index
-   ../submodules/parser/docs/installationprocedure/index
-
-
-Pharos
---------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/pharos/docs/specification/index
-   ../submodules/pharos/docs/configguide/index
-
-Promise
---------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/promise/docs/requirements/index
-   ../submodules/promise/docs/installationprocedure/index
-   ../submodules/promise/docs/userguide/index
+------
 
+* :doc:`Parser overview <parser:index>`
+* :doc:`Parser Installation Guide <parser:release/installation/index>`
+* :doc:`Parser Config Guide <parser:release/configguide/index>`
+* :doc:`Parser User Guide  <parser:release/userguide/index>`
 
 SDNVPN
 --------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/sdnvpn/docs/scenarios/os-odl_l2-bgpvpn/index
-   ../submodules/sdnvpn/docs/userguide/index
-   ../submodules/sdnvpn/docs/release-notes/index
 
+* :doc:`Sdnvpn Overview <sdnvpn:index>`
+* :doc:`Sdnvpn Requirements <sdnvpn:development/requirements/index>`
+* :doc:`Sdnvpn Installation Guide <sdnvpn:release/installation/index>`
+* :doc:`Sdnvpn Config Guide <sdnvpn:release/configguide/index>`
+* :doc:`Sdnvpn User Guide <sdnvpn:release/userguide/index>`
+* :doc:`Sdnvpn Feature and API usage guidelines <sdnvpn:development/design/index>`
 
 SFC
------
-.. toctree::
-   :maxdepth: 1
+---
 
-   ../submodules/sfc/docs/userguide/index
-   ../submodules/sfc/docs/releasenotes/index
-   ../submodules/sfc/docs/installationprocedure/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>`