summaryrefslogtreecommitdiffstats
path: root/docs/release/userguide
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/release/userguide
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/release/userguide')
-rw-r--r--docs/release/userguide/feature.userguide.rst17
-rw-r--r--docs/release/userguide/index.rst6
2 files changed, 10 insertions, 13 deletions
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.