Fix Calipso link on index

[opnfvdocs.git] / docs / featureprojects.rst

diff --git a/docs/featureprojects.rst b/docs/featureprojects.rst
index e611f6d..447f816 100644 (file)
--- a/docs/featureprojects.rst
+++ b/docs/featureprojects.rst
@@ -1,297 +1,106 @@
+.. _opnfv-featureprojects:
+
 OPNFV Projects
-================
+==============
 
 Apex
 ----
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/apex/docs/development/overview/index
-   ../submodules/apex/docs/development/requirements/index
-   ../submodules/apex/docs/release/installation/index
-   ../submodules/apex/docs/release/configguide/index
-   ../submodules/apex/docs/release/userguide/index
-   ../submodules/apex/docs/development/design/index
-   ../submodules/apex/docs/development/manuals/index
 
+* :doc:`Apex Overview <apex:index>`
+* :doc:`Apex Installation instructions <apex:release/installation/index>`
 
 Armband
 -------
-.. toctree::
-   :maxdepth: 1
 
-   ../submodules/armband/docs/development/overview/index
-   ../submodules/armband/docs/development/requirements/index
-   ../submodules/armband/docs/release/installation/index
-   ../submodules/armband/docs/release/configguide/index
-   ../submodules/armband/docs/release/userguide/index
-   ../submodules/armband/docs/development/design/index
-   ../submodules/armband/docs/development/manuals/index
+* :doc:`Armband Overview <armband:index>`
+* :doc:`Armband Installation <armband:release/installation/index>`
+* :doc:`Fuel User Guide <armband:release/userguide/index>`
 
 
 Availability
 ------------
-.. toctree::
-   :maxdepth: 1
 
-   ../submodules/availability/docs/development/overview/index
-   ../submodules/availability/docs/development/requirements/index
-   ../submodules/availability/docs/release/installation/index
-   ../submodules/availability/docs/release/configguide/index
-   ../submodules/availability/docs/release/userguide/index
-   ../submodules/availability/docs/development/design/index
-   ../submodules/availability/docs/development/manuals/index
+* :doc:`Availability overview <availability:index>`
+* :doc:`High Availability Requirement Analysis in OPNFV <availability:development/overview/index>`
 
 
 Barometer
 ---------
-.. toctree::
-   :maxdepth: 1
 
-   ../submodules/barometer/docs/development/overview/index
-   ../submodules/barometer/docs/development/requirements/index
-   ../submodules/barometer/docs/release/installation/index
-   ../submodules/barometer/docs/release/configguide/index
-   ../submodules/barometer/docs/release/userguide/index
-   ../submodules/barometer/docs/development/design/index
-   ../submodules/barometer/docs/development/manuals/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>`
 
+Clover
+------
 
-Bottlenecks
------------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/bottlenecks/docs/development/overview/index
-   ../submodules/bottlenecks/docs/development/requirements/index
-   ../submodules/bottlenecks/docs/release/installation/index
-   ../submodules/bottlenecks/docs/release/configguide/index
-   ../submodules/bottlenecks/docs/release/userguide/index
-   ../submodules/bottlenecks/docs/development/design/index
-   ../submodules/bottlenecks/docs/development/manuals/index
-
+* :doc:`Clover Overview <clover:index>`
 
 Compass4Nfv
 -----------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/compass4nfv/docs/development/overview/index
-   ../submodules/compass4nfv/docs/development/requirements/index
-   ../submodules/compass4nfv/docs/release/installation/index
-   ../submodules/compass4nfv/docs/release/configguide/index
-   ../submodules/compass4nfv/docs/release/userguide/index
-   ../submodules/compass4nfv/docs/development/design/index
-   ../submodules/compass4nfv/docs/development/manuals/index
 
+* :doc:`Compass4nfv Overview <compass4nfv:index>`
+* :doc:`Compass4nfv Installation <compass4nfv:release/installation/index>`
+* :doc:`Compass4nfv Design Guide <compass4nfv:development/design/index>`
 
-Copper
-------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/copper/docs/development/overview/index
-   ../submodules/copper/docs/development/requirements/index
-   ../submodules/copper/docs/release/installation/index
-   ../submodules/copper/docs/release/configguide/index
-   ../submodules/copper/docs/release/userguide/index
-   ../submodules/copper/docs/development/design/index
-   ../submodules/copper/docs/development/manuals/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>`
 
 Doctor
 ------
-.. toctree::
-   :maxdepth: 1
 
-   ../submodules/doctor/docs/development/overview/index
-   ../submodules/doctor/docs/development/requirements/index
-   ../submodules/doctor/docs/release/installation/index
-   ../submodules/doctor/docs/release/configguide/index
-   ../submodules/doctor/docs/release/userguide/index
-   ../submodules/doctor/docs/development/design/index
-   ../submodules/doctor/docs/development/manuals/index
-
-
-Domino
-------
-.. toctree::
-   :maxdepth: 1
+* :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>`
 
-   ../submodules/domino/docs/development/overview/index
-   ../submodules/domino/docs/development/requirements/index
-   ../submodules/domino/docs/release/installation/index
-   ../submodules/domino/docs/release/configguide/index
-   ../submodules/domino/docs/release/userguide/index
-   ../submodules/domino/docs/development/design/index
-   ../submodules/domino/docs/development/manuals/index
-
-
-Fds
----
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/fds/docs/development/overview/index
-   ../submodules/fds/docs/development/requirements/index
-   ../submodules/fds/docs/release/installation/index
-   ../submodules/fds/docs/release/configguide/index
-   ../submodules/fds/docs/release/userguide/index
-   ../submodules/fds/docs/development/design/index
-   ../submodules/fds/docs/development/manuals/index
+Edgecloud
+---------
 
+* :doc:`Edgecloud Overview <edgecloud:index>`
+* :doc:`Edgecloud Requirements <edgecloud:development/requirements/index>`
 
 IPV6
 ----
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/ipv6/docs/development/overview/index
-   ../submodules/ipv6/docs/development/requirements/index
-   ../submodules/ipv6/docs/release/installation/index
-   ../submodules/ipv6/docs/release/configguide/index
-   ../submodules/ipv6/docs/release/userguide/index
-   ../submodules/ipv6/docs/development/design/index
-   ../submodules/ipv6/docs/development/manuals/index
-
-
-Joid
-----
-.. toctree::
-   :maxdepth: 1
 
-   ../submodules/joid/docs/development/overview/index
-   ../submodules/joid/docs/development/requirements/index
-   ../submodules/joid/docs/release/installation/index
-   ../submodules/joid/docs/release/configguide/index
-   ../submodules/joid/docs/release/userguide/index
-   ../submodules/joid/docs/development/design/index
-   ../submodules/joid/docs/development/manuals/index
-
-
-Kvmfornfv
----------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/kvmfornfv/docs/development/overview/index
-   ../submodules/kvmfornfv/docs/development/requirements/index
-   ../submodules/kvmfornfv/docs/release/installation/index
-   ../submodules/kvmfornfv/docs/release/configguide/index
-   ../submodules/kvmfornfv/docs/release/userguide/index
-   ../submodules/kvmfornfv/docs/development/design/index
-   ../submodules/kvmfornfv/docs/development/manuals/index
-
-
-Multisite
----------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/multisite/docs/development/overview/index
-   ../submodules/multisite/docs/development/requirements/index
-   ../submodules/multisite/docs/release/installation/index
-   ../submodules/multisite/docs/release/configguide/index
-   ../submodules/multisite/docs/release/userguide/index
-   ../submodules/multisite/docs/development/design/index
-   ../submodules/multisite/docs/development/manuals/index
-
-
-Netready
---------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/netready/docs/development/overview/index
-   ../submodules/netready/docs/development/requirements/index
-   ../submodules/netready/docs/release/installation/index
-   ../submodules/netready/docs/release/configguide/index
-   ../submodules/netready/docs/release/userguide/index
-   ../submodules/netready/docs/development/design/index
-   ../submodules/netready/docs/development/manuals/index
-
-
-Opera
------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/opera/docs/development/overview/index
-   ../submodules/opera/docs/development/requirements/index
-   ../submodules/opera/docs/release/installation/index
-   ../submodules/opera/docs/release/configguide/index
-   ../submodules/opera/docs/release/userguide/index
-   ../submodules/opera/docs/development/design/index
-   ../submodules/opera/docs/development/manuals/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/development/overview/index
-   ../submodules/parser/docs/development/requirements/index
-   ../submodules/parser/docs/release/installation/index
-   ../submodules/parser/docs/release/configguide/index
-   ../submodules/parser/docs/release/userguide/index
-   ../submodules/parser/docs/development/design/index
-   ../submodules/parser/docs/development/manuals/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>`
 
-
-Promise
--------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/promise/docs/development/overview/index
-   ../submodules/promise/docs/development/requirements/index
-   ../submodules/promise/docs/release/installation/index
-   ../submodules/promise/docs/release/configguide/index
-   ../submodules/promise/docs/release/userguide/index
-   ../submodules/promise/docs/development/design/index
-   ../submodules/promise/docs/development/manuals/index
-
-
-Storperf
+SDNVPN
 --------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/storperf/docs/development/overview/index
-   ../submodules/storperf/docs/development/requirements/index
-   ../submodules/storperf/docs/release/installation/index
-   ../submodules/storperf/docs/release/configguide/index
-   ../submodules/storperf/docs/release/userguide/index
-   ../submodules/storperf/docs/development/design/index
-   ../submodules/storperf/docs/development/manuals/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/development/overview/index
-   ../submodules/sfc/docs/development/requirements/index
-   ../submodules/sfc/docs/release/installation/index
-   ../submodules/sfc/docs/release/configguide/index
-   ../submodules/sfc/docs/release/userguide/index
-   ../submodules/sfc/docs/development/design/index
-   ../submodules/sfc/docs/development/manuals/index
-
-
-Vswitchperf
------------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/vswitchperf/docs/development/overview/index
-   ../submodules/vswitchperf/docs/development/requirements/index
-   ../submodules/vswitchperf/docs/release/installation/index
-   ../submodules/vswitchperf/docs/release/configguide/index
-   ../submodules/vswitchperf/docs/release/userguide/index
-   ../submodules/vswitchperf/docs/development/design/index
-   ../submodules/vswitchperf/docs/development/manuals/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>`