summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorGeorg Kunz <georg.kunz@ericsson.com>2017-03-28 12:57:01 +0200
committerGeorg Kunz <georg.kunz@ericsson.com>2017-03-28 16:16:49 +0000
commit4042107009da73955e87401218583f80375fcd30 (patch)
tree668cd2e6bdf83fb199d7c5e75381584ccc0f6a24 /docs
parentae1076e51f5e1dd783b49bc5479b45c5d59f58c4 (diff)
Fixing broken links in documentation
Using rst references to link to other documentation pages instead of relative HTML links. Change-Id: Id8164a4f50f4fd39c996f5ae354b22f3c960fb08 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com> (cherry picked from commit 0c59ca9234d712a74fa01c1eaba676dfb0080052)
Diffstat (limited to 'docs')
-rw-r--r--docs/release/configguide/postinstall.rst9
-rw-r--r--docs/release/release-notes/release-notes.rst15
-rw-r--r--docs/release/scenarios/os-odl-gluon-noha/index.rst2
-rw-r--r--docs/release/scenarios/os-odl-gluon-noha/scenario.description.rst2
-rw-r--r--docs/release/userguide/feature.userguide.rst17
-rw-r--r--docs/release/userguide/index.rst6
6 files changed, 24 insertions, 27 deletions
diff --git a/docs/release/configguide/postinstall.rst b/docs/release/configguide/postinstall.rst
index 4073393..f18c4ac 100644
--- a/docs/release/configguide/postinstall.rst
+++ b/docs/release/configguide/postinstall.rst
@@ -29,7 +29,7 @@ Automated post installation activities
An overview of all test suites run by the OPNFV pipeline against the
os-odl-gluon-noha scenario as well as the test results can be found at the
`Functest test result overview page.
-<http://testresults.opnfv.org/reporting/functest/release/master/index-status-apex.html>`_
+<http://testresults.opnfv.org/reporting/functest/release/danube/index-status-apex.html>`_
@@ -51,10 +51,9 @@ Platform components validation
.. Describe any component specific validation procedures necessary for your
.. deployment tool in this section.
-As described in the `Gluon scenario description
-<../release_scenarios_os-odl-gluon-noha/index.html>`_, the Gluon framework
-consists of five software components. This section describes how to validate
-their successful installation.
+As described in the :ref:`Gluon scenario description <gluon-scenario>`, the
+Gluon framework consists of five software components. This section describes
+how to validate their successful installation.
* **Gluon core plugin**: Check in the file ``/etc/neutron/neutron.conf`` that
the Neutron core plugin is set to ``gluon``.
diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
index 4d491a1..22b63a9 100644
--- a/docs/release/release-notes/release-notes.rst
+++ b/docs/release/release-notes/release-notes.rst
@@ -12,10 +12,9 @@ Overview
--------
This is the first release of the Gluon framework as part of OPNFV. Please
-review the `scenario description
-<../release_scenarios_os-odl-gluon-noha/index.html>`_ and `Gluon feature guide
-<../release_userguide/index.html>`_ for further details on the scenario, its
-usage, limitations and issues.
+review the :ref:`scenario description <gluon-scenario>` and :ref:`Gluon feature
+guide <netready-userguide>` for further details on the scenario, its usage,
+limitations and issues.
Test results
@@ -23,10 +22,10 @@ Test results
The functionality provided by Gluon is verified by means of a Gluon-specific
test case which is run against the os-odl-gluon-noha scenario. A detailed
-description of the test case can be found at the `scenario description
-<../release_scenarios_os-odl-gluon-noha/index.html>`_. Moreover, all generic
-OPNFV test suites are executed towards this scenario. An overview of all test
-suites and their results can be obtained from the `OPNFV test result dashboard
+description of the test case can be found at the :ref:`scenario description
+<gluon-scenario>`. Moreover, all generic OPNFV test suites are executed
+towards this scenario. An overview of all test suites and their results can be
+obtained from the `OPNFV test result dashboard
<http://testresults.opnfv.org/reporting/functest/release/danube/index-status-apex.html>`_.
All test suites passed multiple consecutive runs as part of the OPNFV release
verification testing.
diff --git a/docs/release/scenarios/os-odl-gluon-noha/index.rst b/docs/release/scenarios/os-odl-gluon-noha/index.rst
index ae99305..490895f 100644
--- a/docs/release/scenarios/os-odl-gluon-noha/index.rst
+++ b/docs/release/scenarios/os-odl-gluon-noha/index.rst
@@ -2,6 +2,8 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) <optionally add copywriters name>
+.. _gluon-scenario:
+
=================
os-odl-gluon-noha
=================
diff --git a/docs/release/scenarios/os-odl-gluon-noha/scenario.description.rst b/docs/release/scenarios/os-odl-gluon-noha/scenario.description.rst
index c73fa36..2adbab5 100644
--- a/docs/release/scenarios/os-odl-gluon-noha/scenario.description.rst
+++ b/docs/release/scenarios/os-odl-gluon-noha/scenario.description.rst
@@ -78,7 +78,7 @@ for configuring the L3VPN service Proton is as follows:
ii) create a new vpn object
iii) bind the port to the vpn object
-More detailed information can be found in the `Gluon feature guide <../release_userguide/index.html>`_.
+More detailed information can be found in the :ref:`Gluon feature guide <netready-userguide>`.
Scenario-specific test cases
diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst
index 6739146..b131787 100644
--- a/docs/release/userguide/feature.userguide.rst
+++ b/docs/release/userguide/feature.userguide.rst
@@ -51,10 +51,11 @@ multiple SDN Controllers in collaborative and interoperable way.
Gluon API Guidelines and Examples
---------------------------------
-This section shows you how to use **Proton** to create the needed objects,
-and then use ``nova boot`` to bind the port to a VM. It is assumed that you
-have already installed Gluon package, including ``etcd`` and **Gluon Plugin**,
-and started **Proton Server**. If not, please refer to [1]_.
+This section shows you how to use **Proton** to create the needed objects, and
+then use ``nova boot`` to bind the port to a VM. It is assumed that you have
+already installed Gluon package, including ``etcd`` and **Gluon Plugin**, and
+started **Proton Server**. If not, please refer to the :ref:`Installation guide
+<netready-installation>`.
Getting Help
~~~~~~~~~~~~
@@ -139,7 +140,8 @@ parameters ``--api net-l3vpn`` are missing.
The following sections give you the general work flow of how to use Proton to
create and configure an L3VPN.
-**For more details and examples, please refer to [2]_**.
+For more details and examples, please refer to the `Gluon upstream user guide
+<https://github.com/openstack/gluon/blob/master/doc/source/usage.rst>`_.
Work Flow of Using L3VPN
++++++++++++++++++++++++
@@ -237,8 +239,3 @@ To Use Gluon in a Project
import gluon
-References
-
-.. [1] ../installation/index
-.. [2] https://github.com/openstack/gluon/blob/master/doc/source/usage.rst
-
diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst
index b33a083..1b70dd9 100644
--- a/docs/release/userguide/index.rst
+++ b/docs/release/userguide/index.rst
@@ -4,9 +4,9 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) <optionally add copywriters name>
-=====================
-<Feature> User Guide
-=====================
+===================
+NetReady User Guide
+===================
.. The feature user guide should provide an OPNFV user with enough information to
.. use the features provided by the feature project in the supported scenarios.