doc/install: use ref for intra-docs links

Use ref instead of external link definitions for intra-docs links.
Add labels if necessary in files within the install/ directory. Use
existing labels for links outside the install/ directory but do not add
new labels outside of the install/ directory.

Signed-off-by: Ville Ojamo <git2233+ceph@ojamo.eu>

diff --git a/doc/install/build-ceph.rst b/doc/install/build-ceph.rst
index 28f1163ff8bd4e67fe4c588baa2f48a5108105c5..b03ae6400bb36f81605715af015bf7e266ef3d18 100644 (file)
--- a/doc/install/build-ceph.rst
+++ b/doc/install/build-ceph.rst
@@ -42,13 +42,13 @@ repository and execute the following::
     cd build
     ninja
 
-See `Installing a Build`_ to install a build in user space and `Ceph README.md`_
+See :ref:`install-storage-cluster-build` to install a build in user space and `Ceph README.md`_
 doc for more details on build.
 
 Build Ceph Packages
 ===================
 
-To build packages, you must clone the `Ceph`_ repository. You can create 
+To build packages, you must clone the :ref:`Ceph repository <install-clone-source>`. You can create
 installation packages from the latest code using ``dpkg-buildpackage`` for 
 Debian/Ubuntu or ``rpmbuild`` for the RPM Package Manager.
 
@@ -61,7 +61,7 @@ Advanced Package Tool (APT)
 ---------------------------
 
 To create ``.deb`` packages for Debian/Ubuntu, ensure that you have cloned the 
-`Ceph`_ repository, installed the `Build Prerequisites`_ and installed 
+:ref:`Ceph repository <install-clone-source>`, installed the `Build Prerequisites`_ and installed
 ``debhelper``::
 
        sudo apt-get install debhelper
@@ -76,7 +76,7 @@ For multi-processor CPUs use the ``-j`` option to accelerate the build.
 RPM Package Manager
 -------------------
 
-To create ``.rpm`` packages, ensure that you have cloned the `Ceph`_ repository,
+To create ``.rpm`` packages, ensure that you have cloned the :ref:`Ceph repository <install-clone-source>`,
 installed the `Build Prerequisites`_ and installed ``rpm-build`` and 
 ``rpmdevtools``::
 
@@ -104,6 +104,4 @@ Build the RPM packages::
 
 For multi-processor CPUs use the ``-j`` option to accelerate the build.
 
-.. _Ceph: ../clone-source
-.. _Installing a Build: ../install-storage-cluster#installing-a-build
 .. _Ceph README.md: https://github.com/ceph/ceph#building-ceph

diff --git a/doc/install/clone-source.rst b/doc/install/clone-source.rst
index 5e414adb4a3faae38bba2591e212de2e070f2d4a..1acc2d1bc29af1b013601576ccdf610a566b4df1 100644 (file)
--- a/doc/install/clone-source.rst
+++ b/doc/install/clone-source.rst
@@ -1,3 +1,5 @@
+.. _install-clone-source:
+
 =========================================
  Cloning the Ceph Source Code Repository
 =========================================

diff --git a/doc/install/get-packages.rst b/doc/install/get-packages.rst
index fa4da4be51dafe63373b9b29142ac24a82ae4a68..e251ee294ea40c2821e00e9d8fbf518008177b2d 100644 (file)
--- a/doc/install/get-packages.rst
+++ b/doc/install/get-packages.rst
@@ -123,7 +123,7 @@ For RPMs::
 The major releases of Ceph are summarized at: :ref:`Releases <ceph-releases-index>`
 
 .. tip:: For non-US users: There might be a mirror close to you where
-         to download Ceph from. For more information see: `Ceph Mirrors`_.
+         to download Ceph from. For more information see: :ref:`install-mirrors`.
 
 Debian Packages
 ~~~~~~~~~~~~~~~
@@ -168,7 +168,7 @@ of Debian and Ubuntu releases supported.
    echo deb https://download.ceph.com/debian-testing/ $(lsb_release -sc) main | sudo tee /etc/apt/sources.list.d/ceph.list
 
 .. tip:: For non-US users: There might be a mirror close to you where
-         to download Ceph from. For more information see: `Ceph Mirrors`_.
+         to download Ceph from. For more information see: :ref:`install-mirrors`.
 
 
 RPM Packages
@@ -234,7 +234,7 @@ You can download the RPMs directly from
    https://download.ceph.com/rpm-testing
 
 .. tip:: For non-US users: There might be a mirror close to you where
-         to download Ceph from. For more information see: `Ceph Mirrors`_.
+         to download Ceph from. For more information see: :ref:`install-mirrors`.
 
 openSUSE Leap 15.1
 ^^^^^^^^^^^^^^^^^^
@@ -389,4 +389,3 @@ line to get the short codename.
 
 .. _the testing Debian repository: https://download.ceph.com/debian-testing/dists
 .. _the shaman page: https://shaman.ceph.com
-.. _Ceph Mirrors: ../mirrors

diff --git a/doc/install/get-tarballs.rst b/doc/install/get-tarballs.rst
index 175d0399b5844ae45922b5b493002c724f7b980f..0f9290bfc72d4dd0909f6b46099e431294109c18 100644 (file)
--- a/doc/install/get-tarballs.rst
+++ b/doc/install/get-tarballs.rst
@@ -7,8 +7,7 @@ source code. You may download source code tarballs for Ceph releases here:
 
 `Ceph Release Tarballs`_
 
-.. tip:: For international users: There might be a mirror close to you where download Ceph from. For more information see: `Ceph Mirrors`_.
+.. tip:: For international users: There might be a mirror close to you where download Ceph from. For more information see: :ref:`install-mirrors`.
 
 
 .. _Ceph Release Tarballs: https://download.ceph.com/tarballs/
-.. _Ceph Mirrors: ../mirrors

diff --git a/doc/install/index.rst b/doc/install/index.rst
index 5a94577a316aaef9ac1c67232cd788231056b5bb..ac84729741282aec1275e80f474e85833e6c3e6f 100644 (file)
--- a/doc/install/index.rst
+++ b/doc/install/index.rst
@@ -53,6 +53,4 @@ Windows
 ~~~~~~~
 
 For Windows installations, consult this document:
-`Windows installation guide`_.
-
-.. _Windows installation guide: ./windows-install
+:ref:`install-windows`.

diff --git a/doc/install/install-storage-cluster.rst b/doc/install/install-storage-cluster.rst
index 2f6263f4708dbbb1c6203454eff4d47b6a740850..c7835e29bc03d3e428a07cd4512ca137df909799 100644 (file)
--- a/doc/install/install-storage-cluster.rst
+++ b/doc/install/install-storage-cluster.rst
@@ -1,3 +1,5 @@
+.. _install_storage_cluster:
+
 ==============================
  Install Ceph Storage Cluster
 ==============================
@@ -79,6 +81,7 @@ Once you have added either release or development packages, or added a
 
    sudo yum install ceph
 
+.. _install-storage-cluster-build:
 
 Installing a Build
 ==================

diff --git a/doc/install/mirrors.rst b/doc/install/mirrors.rst
index ef12f3a49bd0ef1c0b0249d195305670dc63d9eb..99cf5714eab8343423d9e1d2825b2894956684b4 100644 (file)
--- a/doc/install/mirrors.rst
+++ b/doc/install/mirrors.rst
@@ -1,3 +1,5 @@
+.. _install-mirrors:
+
 =============
  Ceph Mirrors
 =============

diff --git a/doc/install/windows-basic-config.rst b/doc/install/windows-basic-config.rst
index 0fe8a1b1b1406d88f663699ea4f03086b65d0668..371f2a39af7ad7ed437ba65126dd25aa7e2c6c14 100644 (file)
--- a/doc/install/windows-basic-config.rst
+++ b/doc/install/windows-basic-config.rst
@@ -1,5 +1,7 @@
 :orphan:
 
+.. _install-windows-basic-config:
+
 ===========================
 Windows basic configuration
 ===========================

diff --git a/doc/install/windows-install.rst b/doc/install/windows-install.rst
index 7789d96622034346a5c0cef06e51eb0025e1bef8..ec1348273ea458834da8b47fc9b9f54ce2595245 100644 (file)
--- a/doc/install/windows-install.rst
+++ b/doc/install/windows-install.rst
@@ -1,5 +1,7 @@
 :orphan:
 
+.. _install-windows:
+
 ==========================
 Installing Ceph on Windows
 ==========================
@@ -15,7 +17,7 @@ Supported platforms
 -------------------
 .. note::
 
-  Please see the `OS recommendations`_ regarding client package support.
+  Please see the :ref:`os-recommendations` regarding client package support.
 
 Windows Server 2019 and Windows Server 2016 are supported. Previous Windows
 Server versions, including Windows client versions such as Windows 10, might
@@ -66,7 +68,7 @@ https://github.com/ceph/ceph/blob/master/README.windows.rst
 Configuration
 =============
 
-Please check the `Windows configuration sample`_ to get started.
+Please check the :ref:`Windows configuration sample <install-windows-basic-config>` to get started.
 
 You'll also need a keyring file. The `General CephFS Prerequisites`_ page provides a
 simple example, showing how a new CephX user can be created and how its secret
@@ -80,12 +82,8 @@ Further reading
 
 * `RBD Windows documentation`_
 * :ref:`CephFS Windows documentation <ceph-dokan>`
-* `Windows troubleshooting`_
+* :ref:`install-windows-troubleshooting`
 
-.. _Windows configuration sample: ../windows-basic-config
 .. _RBD Windows documentation: ../../rbd/rbd-windows/
-.. _Windows troubleshooting: ../windows-troubleshooting
 .. _General CephFS Prerequisites: ../../cephfs/mount-prerequisites
 .. _Client Authentication: ../../cephfs/client-auth
-.. _Windows testing: ../dev/tests-windows
-.. _OS recommendations: ../../start/os-recommendations

diff --git a/doc/install/windows-troubleshooting.rst b/doc/install/windows-troubleshooting.rst
index c41d50b1d716a825944af8bd611d63d84f01c705..89c0a5e5aaa59d3c402f3165790bdbfde16d8523 100644 (file)
--- a/doc/install/windows-troubleshooting.rst
+++ b/doc/install/windows-troubleshooting.rst
@@ -1,5 +1,7 @@
 :orphan:
 
+.. _install-windows-troubleshooting:
+
 ===============================
 Troubleshooting Ceph on Windows
 ===============================