diff options
| author | Andreas Jaeger <aj@suse.com> | 2019-08-09 21:08:42 +0200 |
|---|---|---|
| committer | Andreas Jaeger <aj@suse.com> | 2019-08-25 07:24:57 +0200 |
| commit | e1ea40444e228222b667820ca012c82e186832da (patch) | |
| tree | 512d67dc255a90503b3b3aafa0f1d80fe1670614 | |
| parent | d160f36451cb3eb6fd1ad5f397531450005b3d6c (diff) | |
| download | designate-e1ea40444e228222b667820ca012c82e186832da.tar.gz | |
Docs: Fix broken links and make more robust
The following links are broken:
https://docs.openstack.org/designate/latest/contributor/sourcedoc/backends/djbdns_agent.html
https://docs.openstack.org/designate/latest/contributor/sourcedoc/backends/gdnsd_agent.html
https://docs.openstack.org/designate/latest/contributor/sourcedoc/backends/knot2_agent.html
Fix those.
Also, use in some places internal links instead of external ones to
make linking more robust against renames of files.
Change-Id: Ia4724f03e9bba1a6f05a8290b0eb31790ed9c715
| -rwxr-xr-x | designate/backend/agent_backend/impl_djbdns.py | 2 | ||||
| -rw-r--r-- | designate/backend/agent_backend/impl_gdnsd.py | 2 | ||||
| -rwxr-xr-x | designate/backend/agent_backend/impl_knot2.py | 2 | ||||
| -rw-r--r-- | doc/source/contributor/index.rst | 2 | ||||
| -rw-r--r-- | doc/source/install/get_started.rst | 6 | ||||
| -rw-r--r-- | doc/source/install/next-steps.rst | 4 |
6 files changed, 9 insertions, 9 deletions
diff --git a/designate/backend/agent_backend/impl_djbdns.py b/designate/backend/agent_backend/impl_djbdns.py index dd8ba2df..8129fd5e 100755 --- a/designate/backend/agent_backend/impl_djbdns.py +++ b/designate/backend/agent_backend/impl_djbdns.py @@ -22,7 +22,7 @@ Djbdns DNS agent backend Create, update, delete zones locally on a Djbdns DNS resolver using the axfr-get utility. -`Djbdns User documentation <backends/djbdns_agent.html>`_ +`Djbdns User documentation <../../admin/backends/djbdns_agent.html>`_ .. WARNING:: diff --git a/designate/backend/agent_backend/impl_gdnsd.py b/designate/backend/agent_backend/impl_gdnsd.py index e87dba0c..d25d8cc4 100644 --- a/designate/backend/agent_backend/impl_gdnsd.py +++ b/designate/backend/agent_backend/impl_gdnsd.py @@ -24,7 +24,7 @@ gdnsd utility. Supported Knot versions: >= 2.1, < 3 -`User documentation <backends/gdnsd_agent.html>`_ +`User documentation <../../admin/backends/gdnsd_agent.html>`_ .. WARNING:: diff --git a/designate/backend/agent_backend/impl_knot2.py b/designate/backend/agent_backend/impl_knot2.py index 09f11c60..06010bb5 100755 --- a/designate/backend/agent_backend/impl_knot2.py +++ b/designate/backend/agent_backend/impl_knot2.py @@ -24,7 +24,7 @@ knotc utility. Supported Knot versions: >= 2.1, < 3 -`Knot DNS 2 User documentation <backends/knot2_agent.html>`_ +`Knot DNS 2 User documentation <../../admin/backends/knot2_agent.html>`_ .. WARNING:: diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index 3802524a..36f86eaa 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -1,3 +1,5 @@ +.. _developer_documentation: + ======================= Developer documentation ======================= diff --git a/doc/source/install/get_started.rst b/doc/source/install/get_started.rst index 3401c425..1030b98a 100644 --- a/doc/source/install/get_started.rst +++ b/doc/source/install/get_started.rst @@ -42,8 +42,6 @@ The DNS service consists of the following components: ``Customer Facing DNS Servers`` Serves DNS requests to end users. They are orchestreated by the - ``designate-worker``, and the supported list is maintained `here`_ - - - .. _here: https://docs.openstack.org/designate/latest/admin/support-matrix.html + ``designate-worker``, and the supported list is maintained + :ref:`here <driver_matrix>`. diff --git a/doc/source/install/next-steps.rst b/doc/source/install/next-steps.rst index 1a02f573..7fe20715 100644 --- a/doc/source/install/next-steps.rst +++ b/doc/source/install/next-steps.rst @@ -8,5 +8,5 @@ Your OpenStack environment now includes the designate service. To add additional services, see the `OpenStack install guide <https://docs.openstack.org/install-guide/>`_. -To learn more about the designate service, read the `Designate developer documentation -<https://docs.openstack.org/designate/latest/contributor/index.html>`_. +To learn more about the designate service, read the :ref:`Designate +developer documentation <developer_documentation>`. |