diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/featureprojects.rst | 2 | ||||
-rw-r--r-- | docs/how-to-use-docs/index.rst | 1 | ||||
-rw-r--r-- | docs/release/installation.introduction.rst | 12 | ||||
-rw-r--r-- | docs/release/overview.rst | 6 | ||||
-rw-r--r-- | docs/release/release-notes.rst | 66 | ||||
-rw-r--r-- | docs/release/userguide.introduction.rst | 2 | ||||
m--------- | docs/submodules/availability | 0 | ||||
m--------- | docs/submodules/compass4nfv | 0 | ||||
m--------- | docs/submodules/domino | 0 | ||||
m--------- | docs/submodules/dovetail | 0 | ||||
m--------- | docs/submodules/functest | 0 | ||||
m--------- | docs/submodules/multisite | 0 | ||||
m--------- | docs/submodules/opera | 0 | ||||
m--------- | docs/submodules/qtip | 0 | ||||
m--------- | docs/submodules/releng | 0 | ||||
m--------- | docs/submodules/sdnvpn | 0 | ||||
m--------- | docs/submodules/sfc | 0 | ||||
m--------- | docs/submodules/storperf | 0 | ||||
m--------- | docs/submodules/yardstick | 0 | ||||
-rw-r--r-- | docs/testing/ecosystem/overview.rst | 4 | ||||
-rw-r--r-- | docs/testing/testing-dev.rst | 10 | ||||
-rw-r--r-- | docs/testing/testing-user.rst | 2 |
22 files changed, 27 insertions, 78 deletions
diff --git a/docs/featureprojects.rst b/docs/featureprojects.rst index e611f6dd9..24b4e325b 100644 --- a/docs/featureprojects.rst +++ b/docs/featureprojects.rst @@ -1,3 +1,5 @@ +.. _opnfv-featureprojects: + OPNFV Projects ================ 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 e31c5b1ee..74c24e6bf 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 @@ -73,15 +75,7 @@ The basic deployment validation only addresses a small part of capabilities prov the platform and you may want to execute more exhaustive tests. Some investigation will be required to select the right test suites to run on your platform. -Many of the OPNFV test project provide user-guide documentation and installation instructions as listed below: - -- :ref:`Functest user guide <functest-userguide>` -- :ref:`Yardstick user guide <yardstick-userguidde>` -- :ref:`vSwitchPerf user guide <vswitchperf-userguide>` -- :ref:`Software Fastpath Service Quality Metrics (SFQM) user guide <fastpathmetrics-userguide>` -- :ref:`Bottlenecks user guide <bottlenecks-userguide>` -- :ref:`Storage Performance Benchmarking for NFVI (StorPerf) user guide <storperf-userguide>` - +Many of the OPNFV test project provide user-guide documentation and installation instructions in :ref:`this document <testing-userguide>` Security Notes ============== 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 24f6dc84d..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 @@ -14,88 +16,38 @@ Project release notes: :ref:`Apex Release Notes <apex-releasenotes>` -:ref:`Armband Release Notes <armband-releasenotes>` +:ref:`Armband Release Notes <armband-release-notes-label>` :ref:`Bottlenecks Release Notes <bottlenecks-releasenotes>` :ref:`Compass4nfv Release Notes <compass4nfv-releasenotes>` -:ref:`Conductor Release Notes <conductor-releasenotes>` - :ref:`Copper Release Notes <copper-releasenotes>` -:ref:`Daisy Release Notes <daisy-releasenotes>` - :ref:`Doctor Release Notes <doctor-releasenotes>` :ref:`Domino Release Notes <domino-releasenotes>` -:ref:`Dovetail Release Notes <dovetail-releasenotes>` - -:ref:`Dpacc Release Notes <dpacc-releasenotes>` - -:ref:`Enfv Release Notes <enfv-releasenotes>` - -:ref:`Escalator Release Notes <escalator-releasenotes>` - -:ref:`Fastpathmetrics Release Notes <fastpathmetrics-releasenotes>` - -:ref:`Fds Release Notes <fds-releasenotes>` - -:ref:`Fuel Release Notes <fuel-releasenotes>` +:ref:`FDS Release Notes <fds-releasenotes>` :ref:`Functest Release Notes <functest-releasenotes>` -:ref:`Genesisreq Release Notes <genesisreq-releasenotes>` - -:ref:`Inspector Release Notes <inspector-releasenotes>` - -:ref:`Ipv6 Release Notes <ipv6-releasenotes>` +:ref:`IPV6 Release Notes <ipv6-releasenotes>` :ref:`Joid Release Notes <joid-releasenotes>` -:ref:`Kvmfornfv Release Notes <kvmfornfv-releasenotes>` - -:ref:`Lsoapi Release Notes <lsoapi-releasenotes>` - -:ref:`Moon Release Notes <moon-releasenotes>` +:ref:`KVMforNFV Release Notes <kvmfornfv-releasenotes>` :ref:`Multisite Release Notes <multisite-releasenotes>` :ref:`Netready Release Notes <netready-releasenotes>` -:ref:`Octopus Release Notes <octopus-releasenotes>` - -:ref:`Onosfw Release Notes <onosfw-releasenotes>` - -:ref:`Ovsnfv Release Notes <ovsnfv-releasenotes>` +:ref:`Opera Release Notes <opera-releasenotes>` :ref:`Parser Release Notes <parser-releasenotes>` -:ref:`Pharos Release Notes <pharos-releasenotes>` - -:ref:`Prediction Release Notes <prediction-releasenotes>` - -:ref:`Promise Release Notes <promise-releasenotes>` - :ref:`QTIP Release Notes <qtip-releasenotes>` -:ref:`Releng Release Notes <releng-releasenotes>` - -:ref:`Sdnvpn Release Notes <sdnvpn-releasenotes>` - -:ref:`Sfc Release Notes <sfc-releasenotes>` - -:ref:`Storperf Release Notes <storperf-releasenotes>` - -:ref:`Ves Release Notes <ves-releasenotes>` - -:ref:`Vnf_Forwarding_Graph Release Notes <vnf_forwarding_graph-releasenotes>` - -:ref:`VSPERF Release Notes <vswitchperf-releasenotes>` - -:ref:`Yardstick Release Notes <yardstick-releasenotes>` - -:ref:`Ovno Release Notes <ovno-releasenotes>` +:ref:`SFC Release Notes <sfc-releasenotes>` -:ref:`Snaps Release Notes <snaps-releasenotes>` +:ref:`VSPERF Release Notes <vsperf-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/availability b/docs/submodules/availability -Subproject 126074a0899cd51afda5da62a6db8d3bed03019 +Subproject e83e826789396a4e1a9cd113976bec6860a3ab9 diff --git a/docs/submodules/compass4nfv b/docs/submodules/compass4nfv -Subproject d52a11770689f4fd4d2bc4b9bf8dc09d4dd62eb +Subproject 0523f8c84d0dd1530c725b08d881653f8522287 diff --git a/docs/submodules/domino b/docs/submodules/domino -Subproject d9e1e3aeb6c964d7d2466594a5fc6a681693ff3 +Subproject b49bcd3d3d2454a9a3bd05e2ce58140fbed76be diff --git a/docs/submodules/dovetail b/docs/submodules/dovetail -Subproject e0f4b3a6f279e8e3f4bc05307d60d6983cc6073 +Subproject aa8654d4f3f727f99016aaa540c8d5aa3f79edc diff --git a/docs/submodules/functest b/docs/submodules/functest -Subproject 62661e25ab10f1fea79b8c1e19c6d493b3e12b6 +Subproject 9d6321c95da220cd4a754f242a9ba49a1247db3 diff --git a/docs/submodules/multisite b/docs/submodules/multisite -Subproject 15d60ea52b3a6dbca6da36940a87faa99e6a5f2 +Subproject 05394d97a05f589e9b2dcb21a3b4606368e82f5 diff --git a/docs/submodules/opera b/docs/submodules/opera -Subproject 7ee5c95db62d13d860d51974aa9c0a14404cee5 +Subproject 32c1a6ee6d726d4278869abe718e7fcb61614bc diff --git a/docs/submodules/qtip b/docs/submodules/qtip -Subproject 187b7b7843d4d5071311abd3c001df91b6f469b +Subproject dfc9aacb02fe0e428bd82b39c5365183561909e diff --git a/docs/submodules/releng b/docs/submodules/releng -Subproject 8d56e29f3dd1fad74a678202a70eb9d8bbf00bf +Subproject d0f72ad5325b200bfbbc9ae661adacd72f27afa diff --git a/docs/submodules/sdnvpn b/docs/submodules/sdnvpn -Subproject a8ac0683dc4accfc4d300de20071989c0d1ffb6 +Subproject 70e78577e8736d17fe3d99c9c276d7ca9b6ea89 diff --git a/docs/submodules/sfc b/docs/submodules/sfc -Subproject b23c753e79172a2f865804854f80fb3b963d6f8 +Subproject 89b68dcce2e79251e38e6231a3556b1bdc5fea7 diff --git a/docs/submodules/storperf b/docs/submodules/storperf -Subproject 5fbde2962c159ace29a7b42bc217f1eed810980 +Subproject 6eb2c8d8a8971ee3ae0693feebe509d4ec30a7a diff --git a/docs/submodules/yardstick b/docs/submodules/yardstick -Subproject ab7cd795f6d45bf8bedbe8903cae39bd447d3c1 +Subproject a7b9f846883f9614830227e0bde866aebbde508 diff --git a/docs/testing/ecosystem/overview.rst b/docs/testing/ecosystem/overview.rst index 4ef19a59a..ed1657c87 100644 --- a/docs/testing/ecosystem/overview.rst +++ b/docs/testing/ecosystem/overview.rst @@ -55,8 +55,8 @@ The major testing projects are described in the table below: | | applicable to controllers in general. Collaboration of | | | upstream controller testing experts, external test tool | | | developers and the standards community. Primarily | -| | contribute to upstream/external tooling, then add jobs -| | to run those tools on OPNFV's infrastructure. +| | contribute to upstream/external tooling, then add jobs | +| | to run those tools on OPNFV's infrastructure. | +----------------+---------------------------------------------------------+ | Dovetail | This project intends to define and provide a set of | | | OPNFV related validation criteria that will provide | diff --git a/docs/testing/testing-dev.rst b/docs/testing/testing-dev.rst index 970abe2ae..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 @@ -21,14 +23,6 @@ Bottlenecks ../submodules/bottlenecks/docs/testing/developer/devguide/index -Yardstick ----------- -.. toctree:: - :maxdepth: 1 - - ../submodules/yardstick/docs/testing/developer/devguide/index - - QTIP ----- .. toctree:: diff --git a/docs/testing/testing-user.rst b/docs/testing/testing-user.rst index 8e69a482d..98159727b 100644 --- a/docs/testing/testing-user.rst +++ b/docs/testing/testing-user.rst @@ -1,3 +1,5 @@ +.. _testing-userguide: + .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 |