summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--.gitignore4
-rw-r--r--docs/featureprojects.rst109
-rw-r--r--docs/index.rst2
-rw-r--r--docs/infrastructure/overview.rst8
-rw-r--r--docs/release/installation.introduction.rst7
-rw-r--r--docs/release/release-notes.rst6
-rw-r--r--docs/release/subrelease.rst30
-rw-r--r--docs/release/userguide.introduction.rst10
-rw-r--r--docs/testing/developer/devguide/index.rst2
-rw-r--r--docs/testing/testing-dev.rst24
-rw-r--r--docs/testing/testing-user.rst41
11 files changed, 56 insertions, 187 deletions
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 <apex:index>`
Armband
-------
* :doc:`Armband Overview <armband:index>`
-* :doc:`Installation Guide <armband:release/installation/index>`
-* :doc:`User Guide <armband:release/userguide/index>`
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 <availability:index>`
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 <barometer:index>`
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 <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>`
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 <daisy: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
+* :doc:`Doctor overview <doctor:index>`
Edgecloud
---------
.. toctree::
:maxdepth: 1
- ../submodules/edgecloud/docs/development/requirements/index
+* :doc:`Edgecloud overview <edgecloud: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
-
+* :doc:`IPV6 overview <ipv6: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
-
+* :doc:`JOID overview <joid: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:`Opera overview <opera: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>`
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 <sdnvpn: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
-
+* :doc:`SFC overview <sfc:index>`
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:`<calipso-release-guide>`
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/release/installation.introduction.rst b/docs/release/installation.introduction.rst
index 82c9384a8..e4e1f690f 100644
--- a/docs/release/installation.introduction.rst
+++ b/docs/release/installation.introduction.rst
@@ -57,11 +57,8 @@ description documents provided:
- :ref:`os-nosdn-vpp-noha <os-nosdn-vpp-noha>`
- :ref:`os-nosdn-vpp-ha <os-nosdn-vpp-ha>`
- :ref:`os-odl-ovs-noha <os-odl-ovs-noha>`
-- :ref:`os-odl-sfc-noha-xci <os-odl-sfc-noha>`
-- :ref:`os-odl-sfc-noha-apex <os-odl-sfc-noha2>`
-- :ref:`os-odl-sfc-noha-compass <os-odl-sfc-noha3>`
-- :ref:`os-odl-sfc-ha-apex <os-odl-sfc-ha>`
-- :ref:`os-odl-sfc-ha-compass <os-odl-sfc-ha2>`
+- :ref:`os-odl-sfc-noha <os-odl-sfc-noha>`
+- :ref:`os-odl-sfc-ha <os-odl-sfc-ha>`
- :ref:`os-odl-bgpvpn-noha <os-odl-bgpvpn-noha>`
- :ref:`os-odl-bgpvpn-ha <os-odl-bgpvpn-ha>`
- :ref:`os-nosdn-bar-ha <os-nosdn-bar-ha>`
diff --git a/docs/release/release-notes.rst b/docs/release/release-notes.rst
index 4a5000d28..d102382ff 100644
--- a/docs/release/release-notes.rst
+++ b/docs/release/release-notes.rst
@@ -28,6 +28,8 @@ Project release notes:
:ref:`Compass4nfv Release Notes <compass4nfv-releasenotes>`
+:ref:`Daisy4nfv Release Notes <daisy4nfv-releasenotes>`
+
:ref:`Doctor Release Notes <doctor-releasenotes>`
:ref:`FDS Release Notes <fds-releasenotes>`
@@ -38,12 +40,12 @@ Project release notes:
:ref:`IPV6 Release Notes <ipv6-releasenotes>`
-:ref:`Joid Release Notes <joid-releasenotes>`
-
:ref:`NFVBench Release Notes <nfvbench-releasenotes>`
:ref:`Orchestra Release Notes <orchestra-releasenotes>`
+:ref:`ONOSFW Release Notes <onosfw-releasenotes>`
+
:ref:`OVN4NFV Release Notes <ovn4nfv-releasenotes>`
:ref:`Promise Release Notes <promise-releasenotes>`
diff --git a/docs/release/subrelease.rst b/docs/release/subrelease.rst
index fa4bd95bb..9c653bb89 100644
--- a/docs/release/subrelease.rst
+++ b/docs/release/subrelease.rst
@@ -4,38 +4,18 @@ 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
-
-Daisy
--------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/daisy/docs/release/release-notes/index
- ../submodules/daisy/docs/release/installation/index
+* :ref:`Release Notes <compass4nfv:compass4nfv-releasenotes>`
+* :ref:`Installation <compass4nfv:compass4nfv-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/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst
index 1a8a096ba..b48f37da8 100644
--- a/docs/release/userguide.introduction.rst
+++ b/docs/release/userguide.introduction.rst
@@ -63,19 +63,13 @@ Feature Configuration Guides
- :ref:`Clover Configuration Guide <clover-configguide>`
- :ref:`Container4NFV Configuration Guide <xyz-configguide>`
- :ref:`Doctor Configuration Guide <doctor-configguide>`
-- :ref:`Edge Cloud Configuration Guide <xyz-configguide>`
-- :ref:`FDS Configuration Guide <fds-configguide>`
-- :ref:`High Availability Configuration Guide <xyz-configguide>`
- :ref:`IPv6 Configuration Guide <ipv6-configguide>`
- :ref:`ONOSFW Configuration Guide <onosfw-configguide>`
- :ref:`Orchestra Configuration Guide <orchestra-configguide>`
-- :ref:`OVN4NFV Configuration Guide <xyz-configguide>`
-- :ref:`OVNO Configuration Guide <ovno-configguide>`
- :ref:`Parser Configuration Guide <parser-configguide>`
- :ref:`Promise Configuration Guide <promise:promise-configguide>`
- :ref:`SDNVPN Configuration Guide <sdnvpn-configguide>`
- :ref:`SFC Configuration Guide <sfc-configguide>`
-- :ref:`Stor4NFV Configuration Guide <stor4nfv:stor4nfv-configguide>`
Feature User Guides
===================
@@ -84,15 +78,11 @@ Feature User Guides
- :ref:`Barometer User Guide <barometer-userguide>`
- :ref:`Clover User Guide <clover-userguide>`
- :ref:`Container4NFV User Guide <xyz-userguide>`
-- :ref:`Edge Cloud User Guide <xyz-userguide>`
- :ref:`Doctor User Guide <doctor-userguide>`
-- :ref:`FDS User Guide <fds-userguide>`
-- :ref:`High Availability User Guide <xyz-userguide>`
- :ref:`IPv6 User Guide <ipv6-userguide>`
- :ref:`OpenContrail Virtual Networking User Guide <ovno-userguide>`
- :ref:`ONOSFW User Guide <onosfw-userguide>`
- :ref:`Orchestra User Guide <orchestra-userguide>`
-- :ref:`OVN4NFV User Guide <xyz-userguide>`
- :ref:`OVNO User Guide <ovno-userguide>`
- :ref:`Parser User Guide <parser-userguide>`
- :ref:`SDNVPN User Guide <sdnvpn-userguide>`
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>`
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 <bottlenecks:testing/user/configguide/index>`
+* :doc:`Bottlenecks User Guide <bottlenecks:testing/user/userguide/index>`
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 <dovetail:testing/user/certificationworkflow/index>`
+* :doc:`Guidelines Addendum for 2018.09 release <dovetail:testing/user/ovpaddendum/index>`
+* :doc:`OVP Reviewer Guide <dovetail:testing/user/reviewerguide/index>`
+* :doc:`OVP System Preparation Guide <dovetail:testing/user/systempreparation/index>`
+* :doc:`OVP Testing Specification <dovetail:testing/user/testspecification/index>`
+* :doc:`OVP Testing User Guide <dovetail:testing/user/userguide/index>`
Functest
---------
.. toctree::
:maxdepth: 1
- ../submodules/functest/docs/testing/user/configguide/index
- ../submodules/functest/docs/testing/user/userguide/index
+* :doc:`Functest Installation Guide <functest:testing/user/configguide/index>`
+* :doc:`Functest User Guide <functest:testing/user/userguide/index>`
NFVbench
-----
.. toctree::
:maxdepth: 1
- ../submodules/nfvbench/docs/testing/user/userguide/index
+* :doc:`NFVbench User Guide <nfvbench:testing/user/userguide/index>`
Storperf
@@ -53,7 +46,7 @@ Storperf
.. toctree::
:maxdepth: 1
- ../submodules/storperf/docs/testing/user/index
+* :doc:`StorPerf User Guide <storperf:testing/user/index>`
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 <vswitchperf:testing/user/configguide/index>`
+* :doc:`VSPERF Test Guide <vswitchperf:testing/user/userguide/index>`
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 <yardstick:testing/user/configguide/index>`
+* :doc:`Yardstick User Guide <yardstick:testing/user/userguide/index>`
+
+