From: Aric Gardner Date: Tue, 6 Nov 2018 21:03:19 +0000 (-0500) Subject: Change submodules for :doc: for feature projects X-Git-Tag: opnfv-10.0.0~49^2 X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=329c2fb5f670dca1063a6cc92eca416f90478239;p=opnfvdocs.git Change submodules for :doc: for feature projects In feature projects there were tons of broken links It does not make sense to link to anything but the projects index file here, as we do not control what the project does past having a doc/index.rst The infrastructure guide is in a better shape but has two broken links The projects that are inactive will show greyed out links untill they add an index.rst Change-Id: I9cba2cc7dd355e3ed90cfe72b3646f25cd76558a Signed-off-by: Aric Gardner --- diff --git a/.gitignore b/.gitignore index 7c4785069..f0b2bd26a 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,6 @@ /docs_build/ /docs/projects/ /docs_output/ -/releng/ \ No newline at end of file +/releng/ +.tox +docs/_build/* diff --git a/docs/featureprojects.rst b/docs/featureprojects.rst index b2eac4314..9b3ad3989 100644 --- a/docs/featureprojects.rst +++ b/docs/featureprojects.rst @@ -8,21 +8,12 @@ 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 ` Armband ------- * :doc:`Armband Overview ` -* :doc:`Installation Guide ` -* :doc:`User Guide ` Availability @@ -30,13 +21,7 @@ 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 ` Barometer @@ -44,145 +29,81 @@ 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 ` Clover ------ .. toctree:: :maxdepth: 1 - ../submodules/clover/docs/development/design/index - ../submodules/clover/docs/release/configguide/index - ../submodules/clover/docs/release/userguide/index + +* :doc:`Clover overview ` 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 ` Daisy4NFV --------- .. toctree:: :maxdepth: 1 - ../submodules/daisy/docs/development/design/index - ../submodules/daisy/docs/release/configguide/index - ../submodules/daisy/docs/release/installation/index - +* :doc:`Daisy overview ` 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 +* :doc:`Doctor overview ` Edgecloud --------- .. toctree:: :maxdepth: 1 - ../submodules/edgecloud/docs/development/requirements/index +* :doc:`Edgecloud overview ` 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 - +* :doc:`IPV6 overview ` 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 - +* :doc:`JOID overview ` 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:`Opera overview ` 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 ` SDNVPN -------- .. toctree:: :maxdepth: 1 - ../submodules/sdnvpn/docs/development/overview/index - ../submodules/sdnvpn/docs/development/requirements/index - ../submodules/sdnvpn/docs/release/installation/index - ../submodules/sdnvpn/docs/release/configguide/index - ../submodules/sdnvpn/docs/release/userguide/index - ../submodules/sdnvpn/docs/development/design/index - +* :doc:`Sdnvpn overview ` 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 - +* :doc:`SFC overview ` diff --git a/docs/index.rst b/docs/index.rst index 191153f97..8b683e5fb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -57,7 +57,7 @@ Operations Supporting Tools .. toctree:: :maxdepth: 1 - submodules/calipso/docs/release/index + :ref:`` Found a typo or any other feedback? Send an email to users@opnfv.org or talk to us on IRC_. diff --git a/docs/infrastructure/overview.rst b/docs/infrastructure/overview.rst index 3100907ce..3b15c0ec3 100644 --- a/docs/infrastructure/overview.rst +++ b/docs/infrastructure/overview.rst @@ -42,11 +42,3 @@ Software Infrastructure ----------------------- - :ref:`releng:software-infrastructure` - -Security --------- - -.. toctree:: - :maxdepth: 1 - - ../submodules/releng-anteater/docs/index diff --git a/docs/testing/testing-user.rst b/docs/testing/testing-user.rst index ade27a634..278b4a67c 100644 --- a/docs/testing/testing-user.rst +++ b/docs/testing/testing-user.rst @@ -1,10 +1,3 @@ -.. _testing-userguide: - -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -=================== -Testing User Guides =================== This page provides the links to the installation, configuration and user guides @@ -15,8 +8,8 @@ Bottlenecks .. toctree:: :maxdepth: 1 - ../submodules/bottlenecks/docs/testing/user/configguide/index - ../submodules/bottlenecks/docs/testing/user/userguide/index +* :doc:`Bottlenecks Config Guide ` +* :doc:`Bottlenecks User Guide ` Dovetail / OPNFV Verified Program @@ -24,27 +17,27 @@ Dovetail / OPNFV Verified Program .. toctree:: :maxdepth: 1 - ../submodules/dovetail/docs/testing/user/certificationworkflow/index - ../submodules/dovetail/docs/testing/user/ovpaddendum/index - ../submodules/dovetail/docs/testing/user/reviewerguide/index - ../submodules/dovetail/docs/testing/user/systempreparation/index - ../submodules/dovetail/docs/testing/user/testspecification/index - ../submodules/dovetail/docs/testing/user/userguide/index +* :doc:`OVP Workflow ` +* :doc:`Guidelines Addendum for 2018.09 release ` +* :doc:`OVP Reviewer Guide ` +* :doc:`OVP System Preparation Guide ` +* :doc:`OVP Testing Specification ` +* :doc:`OVP Testing User Guide ` Functest --------- .. toctree:: :maxdepth: 1 - ../submodules/functest/docs/testing/user/configguide/index - ../submodules/functest/docs/testing/user/userguide/index +* :doc:`Functest Installation Guide ` +* :doc:`Functest User Guide ` NFVbench ----- .. toctree:: :maxdepth: 1 - ../submodules/nfvbench/docs/testing/user/userguide/index +* :doc:`NFVbench User Guide ` Storperf @@ -53,7 +46,7 @@ Storperf .. toctree:: :maxdepth: 1 - ../submodules/storperf/docs/testing/user/index +* :doc:`StorPerf User Guide ` VSPERF @@ -62,8 +55,8 @@ VSPERF .. toctree:: :maxdepth: 1 - ../submodules/vswitchperf/docs/testing/user/configguide/index - ../submodules/vswitchperf/docs/testing/user/userguide/index +* :doc:`VSPERF Configuration and User Guide ` +* :doc:`VSPERF Test Guide ` Yardstick @@ -71,5 +64,7 @@ Yardstick .. toctree:: :maxdepth: 1 - ../submodules/yardstick/docs/testing/user/configguide/index - ../submodules/yardstick/docs/testing/user/userguide/index +* :doc:`Yardstick Configuration Guide ` +* :doc:`Yardstick User Guide ` + +