Skip to content

Commit b9e5c12

Browse files
authored
DOCSP-24514 Adds interlinks for replication methods (mongodb#2525)
* DOCSP-24514 Adds interlinks for replication methods * Fixes per Sarah Olson * Fixes per Sarah Olson
1 parent 50286f8 commit b9e5c12

14 files changed

+47
-22
lines changed

source/reference/command/replSetFreeze.txt

+4
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ Definition
2121
:dbcommand:`replSetStepDown` command to make a different node in
2222
the replica set a primary.
2323

24+
.. |method| replace:: :method:`rs.freeze` helper method
25+
.. include:: /includes/fact-dbcommand-tip
26+
27+
2428
Syntax
2529
------
2630

source/reference/command/replSetGetConfig.txt

+3
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ Definition
1818
Returns a document that describes the current :ref:`configuration
1919
<replica-set-configuration-document>` of the :term:`replica set`.
2020

21+
.. |method| replace:: :method:`rs.conf` helper method
22+
.. include:: /includes/fact-dbcommand-tip
23+
2124
Syntax
2225
------
2326

source/reference/command/replSetGetStatus.txt

+4
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ Definition
2727
Because of the frequency of heartbeats, these data can be several
2828
seconds out of date.
2929

30+
.. |method| replace:: :method:`rs.status` helper method
31+
.. include:: /includes/fact-dbcommand-tip
32+
33+
3034
Syntax
3135
------
3236

source/reference/command/replSetInitiate.txt

+3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ Definition
1919

2020
.. |command| replace:: ``replSetInitiate``
2121

22+
.. |method| replace:: :method:`rs.initiate` helper method
23+
.. include:: /includes/fact-dbcommand-tip
24+
2225
.. include:: /includes/fact-dbcommand.rst
2326

2427
.. note::

source/reference/command/replSetReconfig.txt

+4
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ Definition
2121
members. You must run this command on the ``admin``
2222
database of the :term:`primary` replica set member.
2323

24+
.. |method| replace:: :method:`rs.reconfig` helper method
25+
.. include:: /includes/fact-dbcommand-tip
26+
27+
2428
Syntax
2529
------
2630

source/reference/command/replSetStepDown.txt

+3
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ Description
2121

2222
.. include:: /includes/stepdown-intro.rst
2323

24+
.. |method| replace:: :method:`rs.stepDown` helper method
25+
.. include:: /includes/fact-dbcommand-tip
26+
2427
The :dbcommand:`replSetStepDown` can only run on the ``admin`` database.
2528

2629
Syntax

source/reference/command/replSetSyncFrom.txt

+2-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ Description
2020
patterns and in situations where a set member is not replicating
2121
from the desired host.
2222

23-
.. include:: /includes/fact-voting-node-sync-incompatibility.rst
23+
.. |method| replace:: :method:`rs.syncFrom` helper method
24+
.. include:: /includes/fact-dbcommand-tip
2425

2526
Run :dbcommand:`replSetSyncFrom` in the ``admin`` database.
2627

source/reference/method/rs.conf.txt

+2-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ Definition
1818
Returns a document that contains the current :term:`replica set`
1919
configuration.
2020

21-
The method wraps the :dbcommand:`replSetGetConfig` command.
21+
.. |dbcommand| replace:: :dbcommand:`replSetGetConfig` command
22+
.. include:: /includes/fact-mongosh-shell-method-alt
2223

2324
.. include:: /includes/extracts/4.4-replSetGetConfiguration-commitmentStatus.rst
2425

source/reference/method/rs.freeze.txt

+3-6
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ Description
1818
Makes the current :term:`replica set` member ineligible to become
1919
:term:`primary` for the period specified.
2020

21+
.. |dbcommand| replace:: :dbcommand:`replSetFreeze` command
22+
.. include:: /includes/fact-mongosh-shell-method-alt
23+
2124
The :method:`rs.freeze()` method has the following parameter:
2225

2326

@@ -37,9 +40,3 @@ Description
3740

3841
- The duration the member is ineligible to become primary.
3942

40-
41-
42-
43-
44-
:method:`rs.freeze()` provides a wrapper around the :term:`database
45-
command` :dbcommand:`replSetFreeze`.

source/reference/method/rs.initiate.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ Description
2020
:ref:`configuration of a replica set
2121
<replica-set-configuration-document>`.
2222

23+
.. |dbcommand| replace:: :dbcommand:`replSetInitiate` command
24+
.. include:: /includes/fact-mongosh-shell-method-alt
25+
2326
The :method:`rs.initiate()` method has the following parameter:
2427

2528

@@ -38,9 +41,6 @@ Description
3841
configuration is not specified, MongoDB uses a default
3942
replica set configuration.
4043

41-
The :method:`rs.initiate()` method provides a wrapper around the
42-
:dbcommand:`replSetInitiate` command.
43-
4444
IP Binding
4545
----------
4646

source/reference/method/rs.reconfig.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ Definition
1919
replica set configuration. To run the method, you must connect to
2020
the :term:`primary` of the replica set.
2121

22+
.. |dbcommand| replace:: :dbcommand:`replSetReconfig` command
23+
.. include:: /includes/fact-mongosh-shell-method-alt
24+
2225
The :method:`rs.reconfig()` method has the following syntax:
2326

2427
.. code-block:: bash
@@ -86,9 +89,6 @@ Definition
8689
current configuration with :method:`rs.conf()`, modify the
8790
configuration document as needed, and then pass the modified
8891
document to :method:`rs.reconfig()`.
89-
90-
:method:`rs.reconfig()` provides a wrapper around the
91-
:dbcommand:`replSetReconfig` command.
9292

9393
The ``force`` parameter allows a reconfiguration command to be issued
9494
to a non-primary node.

source/reference/method/rs.status.txt

+4-2
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,10 @@ Definition
1616
.. method:: rs.status()
1717

1818
Returns the replica set status from the point of view of the member
19-
where the method is run. This method provides a wrapper around the
20-
:dbcommand:`replSetGetStatus` command.
19+
where the method is run.
20+
21+
.. |dbcommand| replace:: :dbcommand:`replSetGetStatus` command
22+
.. include:: /includes/fact-mongosh-shell-method-alt
2123

2224
This output reflects the current status of the replica set, using
2325
data derived from the heartbeat packets sent by the other members

source/reference/method/rs.stepDown.txt

+3-2
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ Description
2020
.. |behavior-ref| replace:: :ref:`rs.stepDown-behavior`
2121

2222
.. include:: /includes/stepdown-intro.rst
23+
24+
.. |dbcommand| replace:: :dbcommand:`replSetStepDown` command
25+
.. include:: /includes/fact-mongosh-shell-method-alt
2326

2427
The :method:`rs.stepDown()` method has the following parameters:
2528

@@ -62,8 +65,6 @@ Description
6265

6366

6467

65-
:method:`rs.stepDown()` provides a wrapper around the
66-
command :dbcommand:`replSetStepDown`.
6768

6869
.. _rs.stepDown-behavior:
6970

source/reference/method/rs.syncFrom.txt

+6-4
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,14 @@ rs.syncFrom()
1212

1313
.. method:: rs.syncFrom()
1414

15-
Provides a wrapper around the :dbcommand:`replSetSyncFrom`, which
16-
allows administrators to temporarily override the default sync
17-
target for the current member. Specify the name of the member you
15+
Temporarily overrides the default sync target for the current member.
16+
17+
.. |dbcommand| replace:: :dbcommand:`replSetFreeze` command
18+
.. include:: /includes/fact-mongosh-shell-method-alt
19+
20+
Specify the name of the member you
1821
want to replicate from in the form of ``[hostname]:[port]``.
1922

20-
.. include:: /includes/fact-voting-node-sync-incompatibility.rst
2123

2224
Behavior
2325
--------

0 commit comments

Comments
 (0)