Skip to content

Commit f487bf4

Browse files
authored
(DOCSP-26419): Replace Agg-Collation doc directives (#2174)
* replace doc directives * fix build and a few outliers * small fix from copy review
1 parent 84c0f78 commit f487bf4

File tree

60 files changed

+129
-128
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+129
-128
lines changed

source/administration/production-checklist-operations.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,8 +107,8 @@ Sharding
107107

108108
.. cssclass:: checklist
109109

110-
- Place your :doc:`config servers
111-
</core/sharded-cluster-config-servers>` on dedicated hardware for
110+
- Place your :ref:`config servers
111+
<sharding-config-server>` on dedicated hardware for
112112
optimal performance in large clusters. Ensure that the hardware has
113113
enough RAM to hold the data files entirely in memory and that it
114114
has dedicated storage.

source/aggregation.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _aggregation:
2+
13
======================
24
Aggregation Operations
35
======================

source/core/authorization.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ authorization using the :option:`--auth <mongod --auth>` or the
2626
authentication </core/security-internal-authentication>` also enables
2727
client authorization.
2828

29-
Once access control is enabled, users must :doc:`authenticate
30-
</core/authentication>` themselves.
29+
Once access control is enabled, users must :ref:`authenticate
30+
<authentication>` themselves.
3131

3232
.. _roles:
3333

source/core/data-model-operations.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ increase the throughput of insert and update operations, or distribute
1919
activity to a sharded cluster more effectively.
2020

2121
When developing a data model, analyze all of your application's
22-
:doc:`read and write operations </crud>` in conjunction with the
22+
:ref:`read and write operations <crud>` in conjunction with the
2323
following considerations.
2424

2525
.. _data-model-atomicity:

source/core/document.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Documents
1515
MongoDB stores data records as BSON documents. BSON is a binary
1616
representation of :term:`JSON` documents, though it contains more data
1717
types than JSON. For the BSON spec, see `bsonspec.org
18-
<http://bsonspec.org/>`_. See also :doc:`/reference/bson-types`.
18+
<http://bsonspec.org/>`_. See also :ref:`bson-types`.
1919

2020
.. include:: /images/crud-annotated-document.rst
2121

@@ -37,8 +37,8 @@ following structure:
3737
fieldN: valueN
3838
}
3939

40-
The value of a field can be any of the BSON :doc:`data types
41-
</reference/bson-types>`, including other documents, arrays, and arrays
40+
The value of a field can be any of the BSON :ref:`data types
41+
<bson-types>`, including other documents, arrays, and arrays
4242
of documents. For example, the following document contains values of varying types:
4343

4444
.. code-block:: javascript
@@ -252,8 +252,8 @@ The ``_id`` field has the following behavior and constraints:
252252
_ If the ``_id`` contains subfields, the subfield names cannot begin
253253
with a (``$``) symbol.
254254

255-
- The ``_id`` field may contain values of any :doc:`BSON data type
256-
</reference/bson-types>`, other than an array, regex, or undefined.
255+
- The ``_id`` field may contain values of any :ref:`BSON data type
256+
<bson-types>`, other than an array, regex, or undefined.
257257

258258
.. warning:: To ensure functioning replication, do not store values
259259
that are of the BSON regular expression type in the ``_id``

source/core/hashed-sharding.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ inserts similar to the following:
8080
.. include:: /images/sharded-cluster-monotonic-distribution.rst
8181

8282
Since the value of ``X`` is always increasing, the chunk with an upper bound
83-
of :doc:`maxKey</reference/bson-types>` receives the majority incoming writes. This
83+
of :bsontype:`MaxKey` receives the majority incoming writes. This
8484
restricts insert operations to the single shard containing this chunk, which
8585
reduces or removes the advantage of distributed writes in a sharded cluster.
8686

@@ -178,7 +178,7 @@ Sharding Empty Collection on Compound Hashed Shard Key with Hashed Field Prefix
178178

179179
- The sharding operation creates empty chunks to cover the entire
180180
range of the shard key values and performs an initial chunk
181-
distribution. The value of all non-hashed fields is ``MinKey`` at
181+
distribution. The value of all non-hashed fields is :bsontype:`MinKey` at
182182
each split point. By default, the operation creates 2 chunks per
183183
shard and migrates across the cluster. You can use
184184
``numInitialChunks`` option to specify a different number of

source/core/index-creation.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -324,8 +324,8 @@ can occur, such as:
324324
fails to build the index for an associated shard or incorrectly
325325
builds an index with different specification.
326326

327-
Starting in MongoDB 4.4 (and in MongoDB 4.2.6), the :doc:`config server
328-
</core/sharded-cluster-config-servers>` primary periodically checks for
327+
Starting in MongoDB 4.4 (and in MongoDB 4.2.6), the :ref:`config server
328+
<sharding-config-server>` primary periodically checks for
329329
index inconsistencies across the shards for sharded collections. To
330330
configure these periodic checks, see
331331
:parameter:`enableShardedIndexConsistencyCheck` and

source/core/security-transport-encryption.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,8 +253,8 @@ Identity Verification
253253
---------------------
254254

255255
In addition to encrypting connections, TLS/SSL allows for authentication
256-
using certificates, both for :doc:`client authentication
257-
</core/authentication>` and for :doc:`internal authentication
256+
using certificates, both for :ref:`client authentication
257+
<authentication>` and for :doc:`internal authentication
258258
</core/security-internal-authentication>` of members of replica sets and
259259
sharded clusters.
260260

source/core/sharded-cluster-config-servers.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ updates the cache when there are metadata changes for the cluster, such
3030
as :ref:`adding a shard <sharding-procedure-add-shard>`. Shards also read
3131
chunk metadata from the config servers.
3232

33-
The config servers also store :doc:`authentication` configuration
33+
The config servers also store :ref:`authentication` configuration
3434
information such as :doc:`Role-Based Access
3535
Control</core/authorization>` or :doc:`internal
3636
authentication</core/security-internal-authentication>` settings for
@@ -79,8 +79,8 @@ collections <metadata-system-collections>` for internal use.
7979
The :doc:`config database </reference/config-database>` contains the
8080
collections that contain the sharded cluster metadata. MongoDB writes
8181
data to the :doc:`config database </reference/config-database>` when
82-
the metadata changes, such as after a :doc:`chunk migration
83-
</core/sharding-balancer-administration>` or a :doc:`chunk split
82+
the metadata changes, such as after a :ref:`chunk migration
83+
<sharding-balancing>` or a :doc:`chunk split
8484
</core/sharding-data-partitioning>`.
8585

8686
Users should avoid writing directly to the config database in the

source/core/sharding-choose-a-shard-key.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,10 +124,10 @@ A shard key on a value that increases or decreases monotonically is more
124124
likely to distribute inserts to a single chunk within the cluster.
125125

126126
This occurs because every cluster has a chunk that captures a range with
127-
an upper bound of :doc:`maxKey</reference/bson-types>`. ``maxKey``
127+
an upper bound of :bsontype:`MaxKey`. ``maxKey``
128128
always compares as higher than all other values. Similarly, there is a
129129
chunk that captures a range with a lower bound of
130-
:doc:`minKey</reference/bson-types>`. ``minKey`` always compares as
130+
:bsontype:`MinKey`. ``minKey`` always compares as
131131
lower than all other values.
132132

133133
If the shard key value is always increasing, all new inserts are routed

source/core/text-search-operators.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,14 @@ operators, including restrictions and behavior, see:
4646
Aggregation Pipeline
4747
--------------------
4848

49-
When working with :doc:`/aggregation` pipelines, use
49+
When working with :ref:`aggregation <aggregation>` pipelines, use
5050
:pipeline:`$match` with a :query:`$text` expression to execute a text
5151
search query. To sort the results in order of relevance score, use the
5252
:expression:`$meta` *aggregation operator* in the :pipeline:`$sort`
5353
stage [#meta-aggregation]_.
5454

5555
For more information and examples of text search in
56-
:doc:`/aggregation` pipelines, see
56+
:ref:`aggregation` pipelines, see
5757
:doc:`/tutorial/text-search-in-aggregation`.
5858

5959
.. include:: /includes/fact-atlas-search-search-stage.rst

source/core/zone-sharding.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,8 @@ the specified parameter.
102102
One valid use of zone ranges on a hashed field is to restrict the data
103103
for a collection to the shard or shards in a single zone. Create a zone
104104
range that covers the entire range of possible hashed shard key values
105-
using :doc:`minKey </reference/bson-types>` as the lower bound and
106-
:doc:`maxkey </reference/bson-types>` as the upper bound.
105+
using :bsontype:`MinKey` as the lower bound and
106+
:bsontype:`MaxKey` as the upper bound.
107107

108108
To define ranges, MongoDB provides the :dbcommand:`updateZoneKeyRange`
109109
command and the associated helper methods

source/faq/fundamentals.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -124,9 +124,9 @@ store data for the collections.
124124
Does MongoDB support SQL?
125125
-------------------------
126126

127-
Not directly, no. However, MongoDB does support a rich query language of its own. For
128-
examples on using MongoDB's query language, see
129-
:doc:`/crud`
127+
Not directly, no. However, MongoDB does support a rich query language of
128+
its own. For examples on using MongoDB's query language, see
129+
:ref:`crud`.
130130

131131
You can also use the `MongoDB Connector for BI
132132
<https://www.mongodb.com/products/bi-connector>`_ to query

source/faq/sharding.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ the :doc:`/sharding` section in the manual, which provides an
2424
- :ref:`sharding-availability`
2525

2626
- :doc:`/core/sharding-data-partitioning` and
27-
:doc:`Chunk Migration Process </core/sharding-balancer-administration>`
27+
:ref:`Chunk Migration Process <sharding-balancing>`
2828

2929
- :doc:`/tutorial/troubleshoot-sharded-clusters`
3030

source/includes/extracts-collation.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ content: |
55
---
66
ref: collation-description
77
content: |
8-
:doc:`Collation </reference/collation>` allows users to specify
8+
:ref:`Collation <collation>` allows users to specify
99
language-specific rules for string comparison, such as rules for
1010
lettercase and accent marks.
1111

source/includes/extracts-fact-query-bitwise.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ content: |
44
55
* - ``{ <field>: { {{op}}: <numeric bitmask> } }``
66
7-
* - ``{ <field>: { {{op}}: <`` :doc:`BinData </reference/bson-types>` ``bitmask> } }``
7+
* - ``{ <field>: { {{op}}: <`` :bsontype:`BinData <Binary>` ``bitmask> } }``
88
99
* - ``{ <field>: { {{op}}: [ <position1>, <position2>, ... ] } }``
1010
1111
The ``field`` value must be either numeric or a
12-
:doc:`BinData </reference/bson-types>` instance. Otherwise, :query:`{{op}}`
12+
:bsontype:`BinData <Binary>` instance. Otherwise, :query:`{{op}}`
1313
will not match the current document.
1414
1515
Numeric Bitmask
@@ -18,7 +18,7 @@ content: |
1818
:query:`{{op}}` will return an error.
1919
2020
BinData Bitmask
21-
You can also use an arbitrarily large :doc:`BinData </reference/bson-types>`
21+
You can also use an arbitrarily large :bsontype:`BinData <Binary>`
2222
instance as a bitmask.
2323
2424
Position List
@@ -134,7 +134,7 @@ content: |
134134
to be set for the negative number ``-5``, but bit position ``200`` to be clear
135135
for the positive number ``+5``.
136136
137-
In contrast, :doc:`BinData </reference/bson-types>` instances are zero-extended.
137+
In contrast, :bsontype:`BinData <Binary>` instances are zero-extended.
138138
For example, given the following document:
139139
140140
.. code-block:: javascript

source/includes/extracts-parent-fact-count-on-sharded-clusters.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ ref: _fact-count-sharded-clusters
22
content: |
33
On a sharded cluster, {{countOp}} can result in an *inaccurate* count if
44
:term:`orphaned documents <orphaned document>` exist or if a
5-
:doc:`chunk migration </core/sharding-balancer-administration>` is in progress.
5+
:ref:`chunk migration <sharding-balancing>` is in progress.
66
77
To avoid these situations, on a sharded cluster, use the
88
:method:`db.collection.aggregate()` method:

source/includes/fact-auth-restrictions-array-contents.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ following fields. The server throws an error if the
3838
unable to authenticate the user.
3939

4040
For more information on authentication in MongoDB, see
41-
:doc:`Authentication </core/authentication/>`.
41+
:ref:`authentication`.

source/includes/fact-index-key-length-operation-behaviors.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,6 @@ corresponding index entry exceeds the |limit|.
5757

5858
.. index-field-limit-chunk-migration
5959
60-
For existing sharded collections, :doc:`chunk migration
61-
</core/sharding-balancer-administration>` will fail if the chunk has a document
60+
For existing sharded collections, :ref:`chunk migration
61+
<sharding-balancing>` will fail if the chunk has a document
6262
that contains an indexed field whose index entry exceeds the |limit|.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
For most data types, :doc:`comparison
22
operators</reference/operator/query-comparison>` only perform
33
comparisons on fields where the
4-
:doc:`BSON type</reference/bson-types>` matches the
4+
:ref:`BSON type <bson-types>` matches the
55
query value's type. MongoDB supports limited cross-BSON comparison
66
through :ref:`type-bracketing`.

source/includes/in-use-encryption/update-a-key.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ To add a {+dek-abbr+} to your {+key-vault-long+}, use the ``createKey`` method o
44
To delete or update a {+dek-abbr+}, use one of the following mechanisms:
55

66
- The ``rewrapManyDataKey`` method
7-
- Standard :manual:`CRUD </crud>` operations
7+
- Standard :ref:`CRUD <crud>` operations
88

99
To learn more about the ``rewrapManyDataKey`` method, see the documentation
1010
of the method for your client or driver:

source/includes/steps-3.2-downgrade-sharded-cluster.yaml

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ title: "Check the ``minOpTimeUpdaters`` value."
1111
level: 4
1212
ref: 3.2-downgrade-minoptimerecovery
1313
content: |
14-
If the sharded cluster uses :doc:`CSRS
15-
</core/sharded-cluster-config-servers>`, for *each* shard, check
14+
If the sharded cluster uses :ref:`CSRS
15+
<sharding-config-server>`, for *each* shard, check
1616
the ``minOpTimeUpdaters`` value to see if it is zero. A
1717
``minOpTimeUpdaters`` value of zero indicates that there are no
1818
migrations in progress. A non-zero value indicates either that a
@@ -44,8 +44,8 @@ title: "Prepare CSRS Config Servers for downgrade."
4444
level: 4
4545
ref: 3.2-downgrade-csrs
4646
content: |
47-
If the sharded cluster uses :doc:`CSRS
48-
</core/sharded-cluster-config-servers>`:
47+
If the sharded cluster uses :ref:`CSRS
48+
<sharding-config-server>`:
4949
5050
a. :ref:`Remove secondary members from the replica set
5151
<remove-member-using-reconfig>` to have only a primary and two
@@ -99,13 +99,12 @@ content: |
9999
100100
#. If you are rolling back to MMAPv1:
101101
102-
a. Start a :doc:`CSRS </core/sharded-cluster-config-servers>` member as
102+
a. Start a :ref:`CSRS <sharding-config-server>` member as
103103
a standalone; i.e. without the :option:`--replSet <mongod --replSet>`
104104
or, if using a configuration file, :setting:`replication.replSetName`.
105105
106106
#. Run :binary:`~bin.mongodump` to dump the ``config`` database, then
107-
shutdown the :doc:`CSRS </core/sharded-cluster-config-servers>`
108-
member.
107+
shutdown the CSRS member.
109108
110109
.. code-block:: bash
111110

source/includes/steps-convert-replica-set-enable-sharding.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ action:
6060
code: |
6161
{ "collectionsharded" : "test.test_collection", "ok" : 1 }
6262
post: |
63-
The :doc:`balancer </core/sharding-balancer-administration>` redistributes
63+
The :ref:`balancer <sharding-balancing>` redistributes
6464
chunks of documents when it next runs. As clients insert additional
6565
documents into this collection, the :binary:`~bin.mongos` routes the
6666
documents to the appropriate shard.

source/index.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Work with your data in MongoDB
9292

9393
Use aggregation pipelines to process your data in multiple stages and return the computed results.
9494

95-
:doc:`To learn more, see Aggregation </aggregation>`
95+
To learn more, see :ref:`aggregation`.
9696

9797
.. code-block:: javascript
9898

source/introduction.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ MongoDB provides high performance data persistence. In particular,
6060
Query API
6161
~~~~~~~~~
6262

63-
The MongoDB Query API supports :doc:`read and write
64-
operations (CRUD) </crud>` as well as:
63+
The MongoDB Query API supports :ref:`read and write
64+
operations (CRUD) <crud>` as well as:
6565

6666
- :ref:`Data Aggregation <aggregation-pipeline>`
6767

source/query-api.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ your data.
1717

1818
The |query-api| comprises two ways to query data in MongoDB:
1919

20-
- :doc:`CRUD Operations </crud>`
21-
- :doc:`Aggregation pipelines </core/aggregation-pipeline>`
20+
- :ref:`CRUD Operations <crud>`
21+
- :ref:`Aggregation pipelines <aggregation-pipeline>`
2222

2323
You can use the |query-api| to perform:
2424

source/reference/aggregation-commands-comparison.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ MongoDB aggregation commands.
136136
* - More Information
137137

138138
-
139-
- :doc:`/core/aggregation-pipeline`
139+
- :ref:`aggregation-pipeline`
140140
- :method:`db.collection.aggregate()`
141141
- :dbcommand:`aggregate`
142142

source/reference/command/aggregate.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ arguments:
245245
.. include:: /includes/deprecation-aggregate-wo-cursor.rst
246246

247247
For more information about the aggregation pipeline
248-
:doc:`/core/aggregation-pipeline`, :doc:`/reference/aggregation`, and
248+
:ref:`aggregation-pipeline`, :doc:`/reference/aggregation`, and
249249
:doc:`/core/aggregation-pipeline-limits`.
250250

251251
Sessions

source/reference/command/cleanupOrphaned.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ Definition
2323
in the event of a failover. You no longer need to run the
2424
:dbcommand:`cleanupOrphaned` command to clean up orphaned documents.
2525
Instead, use this command to wait for orphaned documents in a chunk
26-
range from a shard key's :doc:`minKey</reference/bson-types>` to its
27-
:doc:`maxKey</reference/bson-types>` for a specified namespace to be
26+
range from a shard key's :bsontype:`MinKey` to its
27+
:bsontype:`MaxKey` for a specified namespace to be
2828
cleaned up from a majority of a shard's members.
2929

3030
**For orphaned documents generated before upgrading to MongoDB

source/reference/command/currentOp.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1460,8 +1460,8 @@ Output Fields
14601460

14611461
The state of the resharding coordinator for the current
14621462
:ref:`resharding operation <sharding-resharding>`. The resharding
1463-
coordinator is an operation that runs on the :doc:`config server
1464-
</core/sharded-cluster-config-servers>` primary. The state is set to
1463+
coordinator is an operation that runs on the :ref:`config server
1464+
<sharding-config-server>` primary. The state is set to
14651465
``unused`` when a new resharding operation starts.
14661466

14671467
Only present on the coordinating config server.

0 commit comments

Comments
 (0)