Skip to content

Commit e03fe65

Browse files
Merge pull request ceph#64848 from bluikko/doc-conf-file-linkify-install
doc/install: Linkify mention of ceph.conf and use ref for links
2 parents f7399ae + c6c3a1f commit e03fe65

File tree

6 files changed

+10
-17
lines changed

6 files changed

+10
-17
lines changed

doc/install/clone-source.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,11 +119,9 @@ will be on the ``main`` branch by default, which is the unstable
119119
development branch. You may choose other branches too.
120120

121121
- ``main``: The unstable development branch.
122-
- ``stable-release-name``: The name of the stable, `Active Releases`_. e.g. ``Pacific``
122+
- ``stable-release-name``: The name of the stable, :ref:`active-releases`. e.g. ``Pacific``
123123
- ``next``: The release candidate branch.
124124

125125
::
126126

127127
git checkout main
128-
129-
.. _Active Releases: https://docs.ceph.com/en/latest/releases/#active-releases

doc/install/get-packages.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ For RPMs::
120120

121121
https://download.ceph.com/rpm-{version}
122122

123-
The major releases of Ceph are summarized at: `Releases`_
123+
The major releases of Ceph are summarized at: :ref:`Releases <ceph-releases-index>`
124124

125125
.. tip:: For non-US users: There might be a mirror close to you where
126126
to download Ceph from. For more information see: `Ceph Mirrors`_.
@@ -387,7 +387,6 @@ line to get the short codename.
387387

388388

389389

390-
.. _Releases: https://docs.ceph.com/en/latest/releases/
391390
.. _the testing Debian repository: https://download.ceph.com/debian-testing/dists
392391
.. _the shaman page: https://shaman.ceph.com
393392
.. _Ceph Mirrors: ../mirrors

doc/install/index_manual.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Get Software
99
============
1010

1111
There are several methods for getting Ceph software. The easiest and most common
12-
method is to `get packages`_ by adding repositories for use with package
12+
method is to :ref:`get packages <packages>` by adding repositories for use with package
1313
management tools such as the Advanced Package Tool (APT) or Yellowdog Updater,
1414
Modified (YUM). You may also retrieve pre-compiled packages from the Ceph
1515
repository. Finally, you can retrieve tarballs or clone the Ceph source code
@@ -66,4 +66,3 @@ sequence.
6666
.. toctree::
6767
:maxdepth: 2
6868

69-
.. _get packages: ../get-packages

doc/install/install-storage-cluster.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ To install Ceph with RPMs, execute the following steps:
3838
enabled = 1
3939

4040
#. Ensure your YUM ``ceph.repo`` entry includes ``priority=2``. See
41-
`Get Packages`_ for details::
41+
:ref:`packages` for details::
4242

4343
[ceph]
4444
name=Ceph packages for $basearch
@@ -91,7 +91,6 @@ executing the following:
9191
sudo ninja install
9292

9393
If you install Ceph locally, ``ninja`` will place the executables in
94-
``usr/local/bin``. You may add the Ceph configuration file to the
94+
``usr/local/bin``. You may add the :ref:`Ceph configuration file <configuring-ceph>` to the
9595
``usr/local/bin`` directory to run Ceph from a single directory.
9696

97-
.. _Get Packages: ../get-packages

doc/install/manual-deployment.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,8 @@ a number of things:
7979
a ``client.admin`` user. So you must generate the admin user and keyring,
8080
and you must also add the ``client.admin`` user to the monitor keyring.
8181

82-
The foregoing requirements do not imply the creation of a Ceph Configuration
83-
file. However, as a best practice, we recommend creating a Ceph configuration
82+
The foregoing requirements do not imply the creation of a :ref:`Ceph Configuration
83+
file <configuring-ceph>`. However, as a best practice, we recommend creating a Ceph configuration
8484
file and populating it with the ``fsid``, the ``mon initial members`` and the
8585
``mon host`` settings.
8686

@@ -529,11 +529,10 @@ You should see output that looks something like this::
529529
-3 1 host osd-node2
530530
1 1 osd.1 up 1
531531

532-
To add (or remove) additional monitors, see `Add/Remove Monitors`_.
532+
To add (or remove) additional monitors, see :ref:`adding-and-removing-monitors`.
533533
To add (or remove) additional Ceph OSD Daemons, see `Add/Remove OSDs`_.
534534

535535

536-
.. _Add/Remove Monitors: ../../rados/operations/add-or-rm-mons
537536
.. _Add/Remove OSDs: ../../rados/operations/add-or-rm-osds
538537
.. _Network Configuration Reference: ../../rados/configuration/network-config-ref
539538
.. _Monitor Config Reference - Data: ../../rados/configuration/mon-config-ref#data

doc/install/manual-freebsd-deployment.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ a number of things:
107107
For example, when you run multiple clusters in a :ref:`multisite configuration <multisite>`,
108108
the cluster name (e.g., ``us-west``, ``us-east``) identifies the cluster for
109109
the current CLI session. **Note:** To identify the cluster name on the
110-
command line interface, specify the a Ceph configuration file with the
110+
command line interface, specify a :ref:`Ceph configuration file <configuring-ceph>` with the
111111
cluster name (e.g., ``ceph.conf``, ``us-west.conf``, ``us-east.conf``, etc.).
112112
Also see CLI usage (``ceph --cluster {cluster-name}``).
113113

@@ -517,11 +517,10 @@ You should see output that looks something like this::
517517
-3 1 host node2
518518
1 1 osd.1 up 1
519519

520-
To add (or remove) additional monitors, see `Add/Remove Monitors`_.
520+
To add (or remove) additional monitors, see :ref:`adding-and-removing-monitors`.
521521
To add (or remove) additional Ceph OSD Daemons, see `Add/Remove OSDs`_.
522522

523523

524-
.. _Add/Remove Monitors: ../../rados/operations/add-or-rm-mons
525524
.. _Add/Remove OSDs: ../../rados/operations/add-or-rm-osds
526525
.. _Network Configuration Reference: ../../rados/configuration/network-config-ref
527526
.. _Monitor Config Reference - Data: ../../rados/configuration/mon-config-ref#data

0 commit comments

Comments
 (0)