Skip to content

Commit fce975d

Browse files
authored
DOCSP-24514 Adds interlinks for replication methods (#2525) (#2549)
* DOCSP-24514 Adds interlinks for replication methods * Fixes per Sarah Olson * Fixes per Sarah Olson
1 parent 2f7f06c commit fce975d

14 files changed

+45
-26
lines changed

source/reference/command/replSetFreeze.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ replSetFreeze
1818
:dbcommand:`replSetStepDown` command to make a different node in
1919
the replica set a primary.
2020

21+
.. |method| replace:: :method:`rs.freeze` helper method
22+
.. include:: /includes/fact-dbcommand-tip
23+
2124
The :dbcommand:`replSetFreeze` command uses the following syntax:
2225

2326
.. code-block:: javascript

source/reference/command/replSetGetConfig.txt

Lines changed: 3 additions & 0 deletions
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

Lines changed: 4 additions & 0 deletions
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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ replSetInitiate
1616

1717
.. |command| replace:: ``replSetInitiate``
1818

19+
.. |method| replace:: :method:`rs.initiate` helper method
20+
.. include:: /includes/fact-dbcommand-tip
21+
1922
.. include:: /includes/fact-dbcommand.rst
2023

2124
.. note::

source/reference/command/replSetReconfig.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ replSetReconfig
1818
members. You must run this command on the ``admin``
1919
database of the :term:`primary` replica set member.
2020

21+
.. |method| replace:: :method:`rs.reconfig` helper method
22+
.. include:: /includes/fact-dbcommand-tip
23+
2124
The command has the following syntax:
2225

2326
.. code-block:: javascript

source/reference/command/replSetStepDown.txt

Lines changed: 3 additions & 0 deletions
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
and has the following prototype form:
2629

source/reference/command/replSetSyncFrom.txt

Lines changed: 2 additions & 1 deletion
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

Lines changed: 2 additions & 1 deletion
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-mongo-shell-method-alt
2223

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

source/reference/method/rs.freeze.txt

Lines changed: 3 additions & 6 deletions
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-mongo-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

Lines changed: 3 additions & 7 deletions
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-mongo-shell-method-alt
25+
2326
The :method:`rs.initiate()` method has the following parameter:
2427

2528

@@ -42,13 +45,6 @@ Description
4245
configuration is not specified, MongoDB uses a default
4346
replica set configuration.
4447

45-
46-
47-
48-
49-
The :method:`rs.initiate()` method provides a wrapper around the
50-
:dbcommand:`replSetInitiate` command.
51-
5248

5349
IP Binding
5450
----------

0 commit comments

Comments
 (0)