doc/install: Linkify mention of ceph.conf and use ref for links

Linkify first mention of config file to ceph.conf docs in:
- install-storage-cluster.rst
- manual-deployment.rst
- manual-freebsd-deployment.rst

Use ref instead of an external link in:
- clone-source.rst
- get-packages.rst
- index_manual.rst
- install-storage-cluster.rst
- manual-deploymen.rst
- manual-freebsd-deployment.rst
Only where a label already exists at the destination.
Delete the old link definition if one was used previously.
That should be about all external links in install/ that can use
existing labels for ref.

Fix an instance of "the a" into just "a" that is consistent with other
similar mentions in manual-freebsd-deployment.rst.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>

diff --git a/doc/install/clone-source.rst b/doc/install/clone-source.rst
index 453d544b68562eef9ddc547893c47844d5a69b8c..5e414adb4a3faae38bba2591e212de2e070f2d4a 100644 (file)
--- a/doc/install/clone-source.rst
+++ b/doc/install/clone-source.rst
@@ -119,11 +119,9 @@ will be on the ``main`` branch by default, which is the unstable
 development branch. You may choose other branches too.
 
 - ``main``: The unstable development branch.
-- ``stable-release-name``: The name of the stable, `Active Releases`_. e.g. ``Pacific``
+- ``stable-release-name``: The name of the stable, :ref:`active-releases`. e.g. ``Pacific``
 - ``next``: The release candidate branch.
 
 ::
 
        git checkout main
-
-.. _Active Releases: https://docs.ceph.com/en/latest/releases/#active-releases

diff --git a/doc/install/get-packages.rst b/doc/install/get-packages.rst
index 4718ecbe76c087a1929cf11bd87313524d721bfa..fa4da4be51dafe63373b9b29142ac24a82ae4a68 100644 (file)
--- a/doc/install/get-packages.rst
+++ b/doc/install/get-packages.rst
@@ -120,7 +120,7 @@ For RPMs::
 
   https://download.ceph.com/rpm-{version}
 
-The major releases of Ceph are summarized at: `Releases`_
+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`_.
@@ -387,7 +387,6 @@ line to get the short codename.
 
 
 
-.. _Releases: https://docs.ceph.com/en/latest/releases/
 .. _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/index_manual.rst b/doc/install/index_manual.rst
index e64b99cb9e6bee1b8b041e939335c3bc6ba68b49..bc32ed0118235e0b2ef81702056b3fe6f4bed640 100644 (file)
--- a/doc/install/index_manual.rst
+++ b/doc/install/index_manual.rst
@@ -9,7 +9,7 @@ Get Software
 ============
 
 There are several methods for getting Ceph software. The easiest and most common
-method is to `get packages`_ by adding repositories for use with package
+method is to :ref:`get packages <packages>` by adding repositories for use with package
 management tools such as the Advanced Package Tool (APT) or Yellowdog Updater,
 Modified (YUM). You may also retrieve pre-compiled packages from the Ceph
 repository. Finally, you can retrieve tarballs or clone the Ceph source code
@@ -66,4 +66,3 @@ sequence.
 .. toctree::
    :maxdepth: 2
 
-.. _get packages: ../get-packages

diff --git a/doc/install/install-storage-cluster.rst b/doc/install/install-storage-cluster.rst
index b35ba72263891571532ffb0895cd594a80d493b9..2f6263f4708dbbb1c6203454eff4d47b6a740850 100644 (file)
--- a/doc/install/install-storage-cluster.rst
+++ b/doc/install/install-storage-cluster.rst
@@ -38,7 +38,7 @@ To install Ceph with RPMs, execute the following steps:
      enabled = 1
 
 #. Ensure your YUM ``ceph.repo`` entry includes ``priority=2``. See
-   `Get Packages`_ for details::
+   :ref:`packages` for details::
 
      [ceph]
      name=Ceph packages for $basearch
@@ -91,7 +91,6 @@ executing the following:
    sudo ninja install
 
 If you install Ceph locally, ``ninja`` will place the executables in
-``usr/local/bin``. You may add the Ceph configuration file to the
+``usr/local/bin``. You may add the :ref:`Ceph configuration file <configuring-ceph>` to the
 ``usr/local/bin`` directory to run Ceph from a single directory.
 
-.. _Get Packages: ../get-packages

diff --git a/doc/install/manual-deployment.rst b/doc/install/manual-deployment.rst
index 30d80d2681b426ff01da02e00e137e6e74f83b06..642aba5494af3260cf7148975e4512d57e489e96 100644 (file)
--- a/doc/install/manual-deployment.rst
+++ b/doc/install/manual-deployment.rst
@@ -79,8 +79,8 @@ a number of things:
   a ``client.admin`` user. So you must generate the admin user and keyring,
   and you must also add the ``client.admin`` user to the monitor keyring.
 
-The foregoing requirements do not imply the creation of a Ceph Configuration
-file. However, as a best practice, we recommend creating a Ceph configuration
+The foregoing requirements do not imply the creation of a :ref:`Ceph Configuration
+file <configuring-ceph>`. However, as a best practice, we recommend creating a Ceph configuration
 file and populating it with the ``fsid``, the ``mon initial members`` and the
 ``mon host`` settings.
 
@@ -529,11 +529,10 @@ You should see output that looks something like this::
        -3      1               host osd-node2
        1       1                       osd.1   up      1
 
-To add (or remove) additional monitors, see `Add/Remove Monitors`_.
+To add (or remove) additional monitors, see :ref:`adding-and-removing-monitors`.
 To add (or remove) additional Ceph OSD Daemons, see `Add/Remove OSDs`_.
 
 
-.. _Add/Remove Monitors: ../../rados/operations/add-or-rm-mons
 .. _Add/Remove OSDs: ../../rados/operations/add-or-rm-osds
 .. _Network Configuration Reference: ../../rados/configuration/network-config-ref
 .. _Monitor Config Reference - Data: ../../rados/configuration/mon-config-ref#data

diff --git a/doc/install/manual-freebsd-deployment.rst b/doc/install/manual-freebsd-deployment.rst
index 0ed47e1ca236945403edfdf2e4dea5fa94f713b2..d32ad96a5e1361c506a5b70416de939caa518ec6 100644 (file)
--- a/doc/install/manual-freebsd-deployment.rst
+++ b/doc/install/manual-freebsd-deployment.rst
@@ -107,7 +107,7 @@ a number of things:
   For example, when you run multiple clusters in a :ref:`multisite configuration <multisite>`,
   the cluster name (e.g., ``us-west``, ``us-east``) identifies the cluster for
   the current CLI session. **Note:** To identify the cluster name on the
-  command line interface, specify the a Ceph configuration file with the
+  command line interface, specify a :ref:`Ceph configuration file <configuring-ceph>` with the
   cluster name (e.g., ``ceph.conf``, ``us-west.conf``, ``us-east.conf``, etc.).
   Also see CLI usage (``ceph --cluster {cluster-name}``).
 
@@ -517,11 +517,10 @@ You should see output that looks something like this::
        -3      1               host node2
        1       1                       osd.1   up      1
 
-To add (or remove) additional monitors, see `Add/Remove Monitors`_.
+To add (or remove) additional monitors, see :ref:`adding-and-removing-monitors`.
 To add (or remove) additional Ceph OSD Daemons, see `Add/Remove OSDs`_.
 
 
-.. _Add/Remove Monitors: ../../rados/operations/add-or-rm-mons
 .. _Add/Remove OSDs: ../../rados/operations/add-or-rm-osds
 .. _Network Configuration Reference: ../../rados/configuration/network-config-ref
 .. _Monitor Config Reference - Data: ../../rados/configuration/mon-config-ref#data