summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/featureprojects.rst242
-rw-r--r--docs/how-to-use-docs/index.rst1
-rw-r--r--docs/release/installation.introduction.rst2
-rw-r--r--docs/release/overview.rst6
-rw-r--r--docs/release/release-notes.rst4
-rw-r--r--docs/release/userguide.introduction.rst2
m---------docs/submodules/apex0
m---------docs/submodules/compass4nfv0
m---------docs/submodules/doctor0
m---------docs/submodules/functest0
m---------docs/submodules/qtip0
m---------docs/submodules/releng0
m---------docs/submodules/sfc0
m---------docs/submodules/snaps0
m---------docs/submodules/storperf0
m---------docs/submodules/yardstick0
-rw-r--r--docs/testing/testing-dev.rst2
17 files changed, 24 insertions, 235 deletions
diff --git a/docs/featureprojects.rst b/docs/featureprojects.rst
index a9ec17d50..24b4e325b 100644
--- a/docs/featureprojects.rst
+++ b/docs/featureprojects.rst
@@ -1,3 +1,5 @@
+.. _opnfv-featureprojects:
+
OPNFV Projects
================
@@ -99,20 +101,6 @@ Copper
../submodules/copper/docs/development/manuals/index
-Daisy
------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/daisy/docs/development/overview/index
- ../submodules/daisy/docs/development/requirements/index
- ../submodules/daisy/docs/release/installation/index
- ../submodules/daisy/docs/release/configguide/index
- ../submodules/daisy/docs/release/userguide/index
- ../submodules/daisy/docs/development/design/index
- ../submodules/daisy/docs/development/manuals/index
-
-
Doctor
------
.. toctree::
@@ -141,34 +129,6 @@ Domino
../submodules/domino/docs/development/manuals/index
-Escalator
----------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/escalator/docs/development/overview/index
- ../submodules/escalator/docs/development/requirements/index
- ../submodules/escalator/docs/release/installation/index
- ../submodules/escalator/docs/release/configguide/index
- ../submodules/escalator/docs/release/userguide/index
- ../submodules/escalator/docs/development/design/index
- ../submodules/escalator/docs/development/manuals/index
-
-
-Fastpathmetrics
----------------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/fastpathmetrics/docs/development/overview/index
- ../submodules/fastpathmetrics/docs/development/requirements/index
- ../submodules/fastpathmetrics/docs/release/installation/index
- ../submodules/fastpathmetrics/docs/release/configguide/index
- ../submodules/fastpathmetrics/docs/release/userguide/index
- ../submodules/fastpathmetrics/docs/development/design/index
- ../submodules/fastpathmetrics/docs/development/manuals/index
-
-
Fds
---
.. toctree::
@@ -183,34 +143,6 @@ Fds
../submodules/fds/docs/development/manuals/index
-Fuel
-----
-.. toctree::
- :maxdepth: 1
-
- ../submodules/fuel/docs/development/overview/index
- ../submodules/fuel/docs/development/requirements/index
- ../submodules/fuel/docs/release/installation/index
- ../submodules/fuel/docs/release/configguide/index
- ../submodules/fuel/docs/release/userguide/index
- ../submodules/fuel/docs/development/design/index
- ../submodules/fuel/docs/development/manuals/index
-
-
-Functest
---------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/functest/docs/development/overview/index
- ../submodules/functest/docs/development/requirements/index
- ../submodules/functest/docs/release/installation/index
- ../submodules/functest/docs/release/configguide/index
- ../submodules/functest/docs/release/userguide/index
- ../submodules/functest/docs/development/design/index
- ../submodules/functest/docs/development/manuals/index
-
-
IPV6
----
.. toctree::
@@ -281,34 +213,6 @@ Netready
../submodules/netready/docs/development/manuals/index
-Octopus
--------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/octopus/docs/development/overview/index
- ../submodules/octopus/docs/development/requirements/index
- ../submodules/octopus/docs/release/installation/index
- ../submodules/octopus/docs/release/configguide/index
- ../submodules/octopus/docs/release/userguide/index
- ../submodules/octopus/docs/development/design/index
- ../submodules/octopus/docs/development/manuals/index
-
-
-Onosfw
-------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/onosfw/docs/development/overview/index
- ../submodules/onosfw/docs/development/requirements/index
- ../submodules/onosfw/docs/release/installation/index
- ../submodules/onosfw/docs/release/configguide/index
- ../submodules/onosfw/docs/release/userguide/index
- ../submodules/onosfw/docs/development/design/index
- ../submodules/onosfw/docs/development/manuals/index
-
-
Opera
-----
.. toctree::
@@ -323,20 +227,6 @@ Opera
../submodules/opera/docs/development/manuals/index
-Ovsnfv
-------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/ovsnfv/docs/development/overview/index
- ../submodules/ovsnfv/docs/development/requirements/index
- ../submodules/ovsnfv/docs/release/installation/index
- ../submodules/ovsnfv/docs/release/configguide/index
- ../submodules/ovsnfv/docs/release/userguide/index
- ../submodules/ovsnfv/docs/development/design/index
- ../submodules/ovsnfv/docs/development/manuals/index
-
-
Parser
------
.. toctree::
@@ -351,20 +241,6 @@ Parser
../submodules/parser/docs/development/manuals/index
-Pharos
-------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/pharos/docs/development/overview/index
- ../submodules/pharos/docs/development/requirements/index
- ../submodules/pharos/docs/release/installation/index
- ../submodules/pharos/docs/release/configguide/index
- ../submodules/pharos/docs/release/userguide/index
- ../submodules/pharos/docs/development/design/index
- ../submodules/pharos/docs/development/manuals/index
-
-
Promise
-------
.. toctree::
@@ -379,76 +255,6 @@ Promise
../submodules/promise/docs/development/manuals/index
-Qtip
-----
-.. toctree::
- :maxdepth: 1
-
- ../submodules/qtip/docs/development/overview/index
- ../submodules/qtip/docs/development/requirements/index
- ../submodules/qtip/docs/release/installation/index
- ../submodules/qtip/docs/release/configguide/index
- ../submodules/qtip/docs/release/userguide/index
- ../submodules/qtip/docs/development/design/index
- ../submodules/qtip/docs/development/manuals/index
-
-
-Releng
-------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/releng/docs/development/overview/index
- ../submodules/releng/docs/development/requirements/index
- ../submodules/releng/docs/release/installation/index
- ../submodules/releng/docs/release/configguide/index
- ../submodules/releng/docs/release/userguide/index
- ../submodules/releng/docs/development/design/index
- ../submodules/releng/docs/development/manuals/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
- ../submodules/sdnvpn/docs/development/manuals/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
-
-
-Snaps
------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/snaps/docs/development/overview/index
- ../submodules/snaps/docs/development/requirements/index
- ../submodules/snaps/docs/release/installation/index
- ../submodules/snaps/docs/release/configguide/index
- ../submodules/snaps/docs/release/userguide/index
- ../submodules/snaps/docs/development/design/index
- ../submodules/snaps/docs/development/manuals/index
-
-
Storperf
--------
.. toctree::
@@ -463,32 +269,18 @@ Storperf
../submodules/storperf/docs/development/manuals/index
-Ves
+SFC
---
.. toctree::
:maxdepth: 1
- ../submodules/ves/docs/development/overview/index
- ../submodules/ves/docs/development/requirements/index
- ../submodules/ves/docs/release/installation/index
- ../submodules/ves/docs/release/configguide/index
- ../submodules/ves/docs/release/userguide/index
- ../submodules/ves/docs/development/design/index
- ../submodules/ves/docs/development/manuals/index
-
-
-Vnf Forwarding Graph
---------------------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/vnf_forwarding_graph/docs/development/overview/index
- ../submodules/vnf_forwarding_graph/docs/development/requirements/index
- ../submodules/vnf_forwarding_graph/docs/release/installation/index
- ../submodules/vnf_forwarding_graph/docs/release/configguide/index
- ../submodules/vnf_forwarding_graph/docs/release/userguide/index
- ../submodules/vnf_forwarding_graph/docs/development/design/index
- ../submodules/vnf_forwarding_graph/docs/development/manuals/index
+ ../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
@@ -505,17 +297,3 @@ Vswitchperf
../submodules/vswitchperf/docs/development/manuals/index
-Yardstick
----------
-.. toctree::
- :maxdepth: 1
-
- ../submodules/yardstick/docs/development/overview/index
- ../submodules/yardstick/docs/development/requirements/index
- ../submodules/yardstick/docs/release/installation/index
- ../submodules/yardstick/docs/release/configguide/index
- ../submodules/yardstick/docs/release/userguide/index
- ../submodules/yardstick/docs/development/design/index
- ../submodules/yardstick/docs/development/manuals/index
-
-
diff --git a/docs/how-to-use-docs/index.rst b/docs/how-to-use-docs/index.rst
index 5e9d0dd38..9c52a6021 100644
--- a/docs/how-to-use-docs/index.rst
+++ b/docs/how-to-use-docs/index.rst
@@ -1,3 +1,4 @@
+.. _documentation-guide:
===================
Documentation Guide
diff --git a/docs/release/installation.introduction.rst b/docs/release/installation.introduction.rst
index 3e6e4090e..72edc61af 100644
--- a/docs/release/installation.introduction.rst
+++ b/docs/release/installation.introduction.rst
@@ -1,3 +1,5 @@
+.. _opnfv-installation:
+
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. SPDX-License-Identifier: CC-BY-4.0
.. (c) Sofia Wallin Ericsson AB
diff --git a/docs/release/overview.rst b/docs/release/overview.rst
index 07a38c18a..594decf7d 100644
--- a/docs/release/overview.rst
+++ b/docs/release/overview.rst
@@ -1,3 +1,5 @@
+.. _opnfv-overview:
+
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. SPDX-License-Identifier: CC-BY-4.0
.. (c) Open Platform for NFV Project, Inc. and its contributors
@@ -112,7 +114,7 @@ an NFV domain, the OPNFV community consumes a sub-set of OpenStack projects wher
composition may vary depending on the installer and scenario.
For details on the scenarios available in OPNFV and the specific composition of components
-refer to the `OPNFV User Guide & Configuration Guide`_
+refer to the :ref:'OPNFV User Guide & Configuration Guide <opnfv-user-config>'
-----------------
Operating Systems
@@ -177,7 +179,7 @@ is provided by a virtual machine and allows control and workload placement using
The initial deployment is done using a staging server, referred to as the "jumphost".
This server-either physical or virtual-is first installed with the installation program
that then installs OpenStack and other components on the controller nodes and compute nodes.
-See the `OPNFV User Guide`_ for more details.
+See the :ref:'OPNFV User Guide & Configuration Guide <opnfv-user-config>' for more details.
The OPNFV Testing Ecosystem
diff --git a/docs/release/release-notes.rst b/docs/release/release-notes.rst
index eab8aec17..3c84e7f9f 100644
--- a/docs/release/release-notes.rst
+++ b/docs/release/release-notes.rst
@@ -1,3 +1,5 @@
+.. _opnfv-releasenotes:
+
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
@@ -34,7 +36,7 @@ Project release notes:
:ref:`Joid Release Notes <joid-releasenotes>`
-:ref:`KVM4NFV Release Notes <kvm4nfv-releasenotes>`
+:ref:`KVMforNFV Release Notes <kvmfornfv-releasenotes>`
:ref:`Multisite Release Notes <multisite-releasenotes>`
diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst
index 18f349793..1a383cb2a 100644
--- a/docs/release/userguide.introduction.rst
+++ b/docs/release/userguide.introduction.rst
@@ -1,3 +1,5 @@
+.. _opnfv-user-config:
+
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. SPDX-License-Identifier: CC-BY-4.0
.. (c) Sofia Wallin (sofia.wallin@ericssion.com)
diff --git a/docs/submodules/apex b/docs/submodules/apex
-Subproject bb4358f417fcd9a24017241725d00b5689df286
+Subproject a684f6b753749c355aee06412bd0f2277935708
diff --git a/docs/submodules/compass4nfv b/docs/submodules/compass4nfv
-Subproject d52a11770689f4fd4d2bc4b9bf8dc09d4dd62eb
+Subproject 0523f8c84d0dd1530c725b08d881653f8522287
diff --git a/docs/submodules/doctor b/docs/submodules/doctor
-Subproject 4e4c3f641110246463516c59b99ae7986e14fa7
+Subproject 7a14778cf61c8a5000dbfb1600510440cad39e9
diff --git a/docs/submodules/functest b/docs/submodules/functest
-Subproject fa399d46b192dd4e986fbc68035a794e6d473ed
+Subproject 9d6321c95da220cd4a754f242a9ba49a1247db3
diff --git a/docs/submodules/qtip b/docs/submodules/qtip
-Subproject 14e9c620366b46481aef204edcf892bbaa4ef6b
+Subproject dfc9aacb02fe0e428bd82b39c5365183561909e
diff --git a/docs/submodules/releng b/docs/submodules/releng
-Subproject b5c5392388aab171c9eca9a97278234100a97cd
+Subproject 0e4dca56cd9beedbbd05d033c79dc5bbd598b5c
diff --git a/docs/submodules/sfc b/docs/submodules/sfc
-Subproject 89b68dcce2e79251e38e6231a3556b1bdc5fea7
+Subproject e61239dbb4f96bb4b798cd3c6e6d6c953d4fcee
diff --git a/docs/submodules/snaps b/docs/submodules/snaps
-Subproject b13ca832ffc24920a7c8ca637f7c468c1306a37
+Subproject b3106eca334e09501cd62739157ae805ee76ff6
diff --git a/docs/submodules/storperf b/docs/submodules/storperf
-Subproject 1bcbe0bac328e26341ba68341d4b809c32b8242
+Subproject 6eb2c8d8a8971ee3ae0693feebe509d4ec30a7a
diff --git a/docs/submodules/yardstick b/docs/submodules/yardstick
-Subproject f782757a1af7bddbcb2af9cebc33d4668ebb24f
+Subproject a7b9f846883f9614830227e0bde866aebbde508
diff --git a/docs/testing/testing-dev.rst b/docs/testing/testing-dev.rst
index 74d4dbbd3..fce557665 100644
--- a/docs/testing/testing-dev.rst
+++ b/docs/testing/testing-dev.rst
@@ -1,3 +1,5 @@
+.. _testing-dev:
+
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0