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

0 commit comments

Comments
 (0)