diff options
-rw-r--r-- | docs/featureprojects.rst | 85 | ||||
-rw-r--r-- | docs/release/subrelease.rst | 28 | ||||
-rw-r--r-- | docs/testing/developer/devguide/index.rst | 2 | ||||
-rw-r--r-- | docs/testing/testing-dev.rst | 24 |
4 files changed, 56 insertions, 83 deletions
diff --git a/docs/featureprojects.rst b/docs/featureprojects.rst index 9b3ad3989..447f81617 100644 --- a/docs/featureprojects.rst +++ b/docs/featureprojects.rst @@ -5,105 +5,102 @@ OPNFV Projects Apex ---- -.. toctree:: - :maxdepth: 1 * :doc:`Apex Overview <apex:index>` +* :doc:`Apex Installation instructions <apex:release/installation/index>` Armband ------- * :doc:`Armband Overview <armband:index>` +* :doc:`Armband Installation <armband:release/installation/index>` +* :doc:`Fuel User Guide <armband:release/userguide/index>` Availability ------------ -.. toctree:: - :maxdepth: 1 * :doc:`Availability overview <availability:index>` +* :doc:`High Availability Requirement Analysis in OPNFV <availability:development/overview/index>` Barometer --------- -.. toctree:: - :maxdepth: 1 -* :doc:`Barometer overview <barometer: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 ------ -.. toctree:: - :maxdepth: 1 -* :doc:`Clover overview <clover:index>` +* :doc:`Clover Overview <clover:index>` Compass4Nfv ----------- -.. toctree:: - :maxdepth: 1 -* :doc:`Compass4nfv overview <compass4nfv:index>` +* :doc:`Compass4nfv Overview <compass4nfv:index>` +* :doc:`Compass4nfv Installation <compass4nfv:release/installation/index>` +* :doc:`Compass4nfv Design Guide <compass4nfv:development/design/index>` Daisy4NFV --------- -.. toctree:: - :maxdepth: 1 * :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 * :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 --------- -.. toctree:: - :maxdepth: 1 -* :doc:`Edgecloud overview <edgecloud:index>` +* :doc:`Edgecloud Overview <edgecloud:index>` +* :doc:`Edgecloud Requirements <edgecloud:development/requirements/index>` IPV6 ---- -.. toctree:: - :maxdepth: 1 -* :doc:`IPV6 overview <ipv6: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>` -Joid ----- -.. toctree:: - :maxdepth: 1 - -* :doc:`JOID overview <joid:index>` - -Opera ------ -.. toctree:: - :maxdepth: 1 - -* :doc:`Opera overview <opera:index>` Parser ------ -.. toctree:: - :maxdepth: 1 * :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 -* :doc:`Sdnvpn overview <sdnvpn: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 -* :doc:`SFC overview <sfc: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>` diff --git a/docs/release/subrelease.rst b/docs/release/subrelease.rst index fa4bd95bb..2013377c8 100644 --- a/docs/release/subrelease.rst +++ b/docs/release/subrelease.rst @@ -4,38 +4,24 @@ Subrelease Guides Apex ----- -.. toctree:: - :maxdepth: 1 - ../submodules/apex/docs/releasenotes/index - ../submodules/apex/docs/installationprocedure/index +* :ref:`Release Notes <apex:apex-releasenotes>` +* :ref:`Installation <apex:apex-installation>` Compass -------- -.. toctree:: - :maxdepth: 1 - ../submodules/compass4nfv/docs/releasenotes/index - ../submodules/compass4nfv/docs/installationprocedure/index +* :ref:`Release Notes <compass4nfv:compass4nfv-releasenotes>` +* :ref:`Installation <compass4nfv:compass4nfv-installation>` Daisy ------- -.. toctree:: - :maxdepth: 1 - ../submodules/daisy/docs/release/release-notes/index - ../submodules/daisy/docs/release/installation/index +* :ref:`Release Notes <daisy:daisy-releasenotes>` +* :ref:`Installation <daisy:daisy-installation>` Fuel ----- -* :ref:`Release Notes <fuel:fuel-release-notes-label>` +* :ref:`Release Notes <fuel:fuel-releasenotes>` * :ref:`Installation <fuel:fuel-installation>` - -Joid ------ -.. toctree:: - :maxdepth: 1 - - ../submodules/joid/docs/releasenotes/index - ../submodules/joid/docs/installationprocedure/index diff --git a/docs/testing/developer/devguide/index.rst b/docs/testing/developer/devguide/index.rst index f661ed335..1c7576b97 100644 --- a/docs/testing/developer/devguide/index.rst +++ b/docs/testing/developer/devguide/index.rst @@ -1,3 +1,5 @@ +.. _developer-devguide: + .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. (c) Christopher Price (Ericsson AB) diff --git a/docs/testing/testing-dev.rst b/docs/testing/testing-dev.rst index 291781455..566cb67be 100644 --- a/docs/testing/testing-dev.rst +++ b/docs/testing/testing-dev.rst @@ -16,46 +16,34 @@ Testing group Bottlenecks ------------ -.. toctree:: - :maxdepth: 1 - ../submodules/bottlenecks/docs/testing/developer/devguide/index +* :doc:`Bottlenecks Developer Guide <bottlenecks:testing/developer/devguide/index>` Dovetail / OPNFV Verified Program --------------------------------- -.. toctree:: - :maxdepth: 1 - ../submodules/dovetail/docs/testing/developer/testcaserequirements/index +* :doc:`OVP Test Case Requirements <dovetail:testing/developer/testcaserequirements/index>` Functest --------- -.. toctree:: - :maxdepth: 1 - ../submodules/functest/docs/testing/developer/devguide/index +* :doc:`Functest Developer Guide <functest:testing/developer/devguide/index>` StorPerf -------- -.. toctree:: - :maxdepth: 1 - ../submodules/storperf/docs/testing/developer/devguide/index +* :doc:`StorPerf Developer Guide <storperf:testing/developer/devguide/index>` VSPERF ------- -.. toctree:: - :maxdepth: 1 - ../submodules/vswitchperf/docs/testing/developer/devguide/index +* :doc:`VSPERF Developer Guide <vswitchperf:testing/developer/devguide/index>` Yardstick --------- -.. toctree:: - :maxdepth: 1 - ../submodules/yardstick/docs/testing/developer/devguide/index +* :doc:`Yardstick Developer Guide <yardstick:testing/developer/devguide/index>` |