From: Ville Ojamo <14869000+bluikko@users.noreply.github.com> Date: Wed, 29 Jul 2026 10:24:56 +0000 (+0700) Subject: doc/install: use ref for intra-docs links X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=3fe15c1f718f432584eaf0c7432b4d3ec798c419;p=ceph.git 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 --- diff --git a/doc/install/build-ceph.rst b/doc/install/build-ceph.rst index 28f1163ff8bd..b03ae6400bb3 100644 --- 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 `. 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 `, 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 `, 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 5e414adb4a3f..1acc2d1bc29a 100644 --- 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 fa4da4be51da..e251ee294ea4 100644 --- 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 ` .. 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 175d0399b584..0f9290bfc72d 100644 --- 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 5a94577a316a..ac8472974128 100644 --- 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 2f6263f4708d..c7835e29bc03 100644 --- 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 ef12f3a49bd0..99cf5714eab8 100644 --- 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 0fe8a1b1b140..371f2a39af7a 100644 --- 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 7789d9662203..ec1348273ea4 100644 --- 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 ` 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 ` -* `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 c41d50b1d716..89c0a5e5aaa5 100644 --- a/doc/install/windows-troubleshooting.rst +++ b/doc/install/windows-troubleshooting.rst @@ -1,5 +1,7 @@ :orphan: +.. _install-windows-troubleshooting: + =============================== Troubleshooting Ceph on Windows ===============================