openstack/designate
Code Issues Proposed changes

Docs: Fix broken links and make more robust

Browse Source 
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
This commit is contained in:
Andreas Jaeger 2019-08-09 21:08:42 +02:00
parent d160f36451
commit e1ea40444e
6 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
designate/backend/agent_backend/impl_djbdns.py
View File

@ -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::

2
designate/backend/agent_backend/impl_gdnsd.py
View File

@ -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::

2
designate/backend/agent_backend/impl_knot2.py
View File

@ -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::

2
doc/source/contributor/index.rst
View File

@ -1,3 +1,5 @@
.. _developer_documentation:
=======================
Developer documentation
=======================

6
doc/source/install/get_started.rst
View File

@ -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>`.

4
doc/source/install/next-steps.rst
View File

@ -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>`.