diff --git a/README.rst b/README.rst index f85b3718bd..528413eab9 100644 --- a/README.rst +++ b/README.rst @@ -35,7 +35,7 @@ Learn about Kolla-Ansible by reading the documentation online `docs.openstack.org `__. Get started by reading the `Developer -Quickstart `__. +Quickstart `__. OpenStack services ------------------ diff --git a/doc/source/contributor/CONTRIBUTING.rst b/doc/source/contributor/CONTRIBUTING.rst index 7092cd88bf..07b24c5287 100644 --- a/doc/source/contributor/CONTRIBUTING.rst +++ b/doc/source/contributor/CONTRIBUTING.rst @@ -30,11 +30,9 @@ Basics Development Environment ======================= -Please follow our `quickstart`_ to deploy your environment and test your +Please follow our :doc:`/user/quickstart` to deploy your environment and test your changes. -.. _quickstart: https://docs.openstack.org/kolla-ansible/latest/quickstart.html - Please use the existing sandbox repository, available at https://git.openstack.org/cgit/openstack-dev/sandbox, for learning, understanding and testing the `Gerrit Workflow`_. diff --git a/doc/source/reference/bifrost.rst b/doc/source/reference/bifrost.rst index 592ed093b7..8025be28c6 100644 --- a/doc/source/reference/bifrost.rst +++ b/doc/source/reference/bifrost.rst @@ -166,7 +166,7 @@ group. In the ``all-in-one`` and ``multinode`` inventory files, a ``bifrost`` group is defined which contains all hosts in the ``deployment`` group. This top level ``deployment`` group is intended to represent the host running the ``bifrost_deploy`` container. By default, this group contains ``localhost``. -See `Multinode Deployment of Kolla `_ +See :doc:`/user/multinode` for details on how to modify the Ansible inventory in a multinode deployment. Bifrost does not currently support running on multiple hosts so the ``bifrost`` diff --git a/doc/source/reference/manila-guide.rst b/doc/source/reference/manila-guide.rst index d72a3b30c1..16f80e5a5e 100644 --- a/doc/source/reference/manila-guide.rst +++ b/doc/source/reference/manila-guide.rst @@ -306,8 +306,7 @@ Modify the file ``/etc/kolla/config/manila.conf`` and add the contents: .. note:: Share migration requires have more than one back end configured. - `Configure multiple back ends - `__. + For details, see :ref:`hnas_configure_multiple_back_ends`. Use the manila migration command, as shown in the following example: diff --git a/doc/source/reference/manila-hnas-guide.rst b/doc/source/reference/manila-hnas-guide.rst index 258c7e5b80..3cf3f3d64d 100644 --- a/doc/source/reference/manila-hnas-guide.rst +++ b/doc/source/reference/manila-hnas-guide.rst @@ -265,6 +265,8 @@ Verify Operation | metadata | {} | +-----------------------------+-----------------------------------------------------------------+ +.. _hnas_configure_multiple_back_ends: + Configure multiple back ends ============================ diff --git a/doc/source/reference/zun-guide.rst b/doc/source/reference/zun-guide.rst index 647d959337..92e28c1660 100644 --- a/doc/source/reference/zun-guide.rst +++ b/doc/source/reference/zun-guide.rst @@ -9,7 +9,7 @@ Preparation and Deployment -------------------------- Zun requires kuryr and etcd services, for more information about how to -configure kuryr refer to `Kuryr Guide `_. +configure kuryr refer to :doc:`kuryr-guide`. To allow Zun Compute connect to the Docker Daemon, add the following in the ``docker.service`` file on each zun-compute node. diff --git a/doc/source/user/quickstart.rst b/doc/source/user/quickstart.rst index ab52bc58b7..bdb996ec4a 100644 --- a/doc/source/user/quickstart.rst +++ b/doc/source/user/quickstart.rst @@ -29,7 +29,7 @@ bare metal or a virtual machine with Kolla. If developing Kolla on a system that provides VirtualBox or Libvirt in addition to Vagrant, use the Vagrant virtual environment documented in -`Development Environment with Vagrant `_. +:doc:`/contributor/vagrant-dev-env`. Prerequisites =============