Skip to content

Commit a4a305f

Browse files
authored
DOCSP-26321 updates collation-related doc directives (#2112)
1 parent f615f97 commit a4a305f

16 files changed

+36
-47
lines changed

source/includes/extracts-views.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ replacement:
6464
ref: views-collation-behavior
6565
content: |
6666
67-
- You can specify a default :doc:`collation </reference/collation>`
67+
- You can specify a default :ref:`collation <collation>`
6868
for a view at creation time. If no collation is specified, the
6969
view's default collation is the "simple" binary comparison
7070
collator. That is, the view does not inherit the collection's
@@ -84,7 +84,7 @@ content: |
8484
8585
If performing an aggregation that involves multiple views, such as
8686
with :pipeline:`$lookup` or :pipeline:`$graphLookup`, the views must
87-
have the same :doc:`collation </reference/collation>`.
87+
have the same :ref:`collation <collation>`.
8888
---
8989
ref: views-public-definition
9090
content: |

source/includes/fact-shardCollection-collation.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
Collation
22
~~~~~~~~~
33

4-
.. versionchanged:: 3.4
5-
6-
If the collection has a default :doc:`collation</reference/collation>`,
4+
If the collection has a default :ref:`collation <collation>`,
75
the |command| command must include a ``collation`` parameter with the
86
value ``{ locale: "simple" }``. For non-empty collections with a
97
default collation, you must have at least one index with the simple

source/includes/note-sharding-collation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33
Queries on the sharded collection continue to use the default
44
collation configured for the collection. To use the shard key
55
index's ``simple`` collation, specify ``{locale : "simple"}``
6-
in the query's :doc:`collation document </reference/collation>`.
6+
in the query's :ref:`collation document <collation>`.

source/indexes.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -291,8 +291,8 @@ Indexes and Collation
291291

292292
.. include:: /includes/extracts/collation-index-use.rst
293293

294-
For more information on collation, see the :doc:`collation reference
295-
page </reference/collation/>`.
294+
For more information on collation, see the :ref:`collation reference
295+
page <collation>`.
296296

297297
.. include:: /includes/extracts/collation-index-type-restrictions.rst
298298

source/reference/collation-locales-defaults.txt

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,15 @@ Behavior
1717

1818
.. include:: /includes/collation-variants.rst
1919

20-
See the :doc:`collation page</reference/collation>` for a full
21-
description of collation behavior and syntax.
20+
See the :ref:`collation page <collation>` for a full description of
21+
collation behavior and syntax.
2222

2323
.. _collation-languages-locales:
2424

2525
Supported Languages and Locales
2626
-------------------------------
2727

28-
MongoDB's :doc:`collation feature</reference/collation>` supports
29-
the following languages. The
28+
MongoDB's collation feature supports the following languages. The
3029
following table lists the supported languages and the associated
3130
locales as defined by `ICU Locale
3231
ID <http://userguide.icu-project.org/locale>`_. [#missing-locale]_
@@ -52,7 +51,7 @@ A collation document contains several
5251
:ref:`optional parameters<collation-document-fields>` in
5352
addition to the required ``locale`` parameter. Depending on which
5453
``locale`` you use, the default parameters may be different.
55-
See the :doc:`collation page</reference/collation>` for a
54+
See the :ref:`collation page <collation>` for a
5655
full description of collation syntax.
5756

5857
The following default parameters are consistent across all locales:

source/reference/command/refineCollectionShardKey.txt

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ Index Considerations
178178

179179
- Index Collation
180180
If the sharded collection has a non-``simple`` default
181-
:doc:`collation </reference/collation>`, then the index *must* include a
181+
:ref:`collation <collation>`, then the index *must* include a
182182
collation document with ``{ locale : "simple" }``. At least one
183183
of the indexes whose fields support the shard key pattern must
184184
have the simple collation.
@@ -239,7 +239,7 @@ Collection with non-``simple`` Collation
239239
To set up the example in the ``test`` database:
240240

241241
#. Create the ``cafés`` collection in the ``test`` database,
242-
specifying French ``fr`` as the default :doc:`collation </reference/collation>`.
242+
specifying French ``fr`` as the default collation.
243243

244244
.. code-block:: javascript
245245

@@ -264,9 +264,8 @@ To modify the shard key to be both the ``customer_id`` field and the
264264

265265
#. :method:`Create the index <db.collection.createIndex()>` to
266266
support the new shard key if the index does not already exist.
267-
Because the collection uses a non-simple :doc:`collation
268-
</reference/collation>`, the index must include the ``collation:
269-
{ locale: "simple" }`` option.
267+
Because the collection uses a non-simple collation, the index
268+
must include the ``collation: { locale: "simple" }`` option.
270269

271270
.. code-block:: javascript
272271

source/reference/command/reshardCollection.txt

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,9 @@ The command takes the following fields:
9797
* - ``collation``
9898
- document
9999
- Optional. If the collection specified to ``reshardCollection``
100-
has a default :doc:`collation </reference/collation>`,
101-
you *must* include a collation document with
102-
``{ locale : "simple" }``, or the ``reshardCollection``
103-
command fails.
100+
has a default :ref:`collation <collation>`, you *must* include a
101+
collation document with ``{ locale : "simple" }``, or the
102+
``reshardCollection`` command fails.
104103

105104
* - ``zones``
106105
- array

source/reference/command/shardCollection.txt

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -130,10 +130,9 @@ The command takes the following fields:
130130
* - ``collation``
131131
- document
132132
- Optional. If the collection specified to ``shardCollection``
133-
has a default :doc:`collation </reference/collation>`,
134-
you *must* include a collation document with
135-
``{ locale : "simple" }``, or
136-
the ``shardCollection`` command fails. At least one of the indexes
133+
has a default :ref:`collation <collation>`, you *must* include a
134+
collation document with ``{ locale : "simple" }``, or the
135+
``shardCollection`` command fails. At least one of the indexes
137136
whose fields support the shard key pattern must have the simple
138137
collation.
139138

source/reference/glossary.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -873,7 +873,7 @@ Glossary
873873

874874
query shape
875875
A combination of query predicate, sort, projection, and
876-
:doc:`collation </reference/collation>`. The query shape allows MongoDB
876+
:ref:`collation <collation>`. The query shape allows MongoDB
877877
to identify logically equivalent queries and analyze their performance.
878878

879879
For the query predicate, only the structure of the predicate,

source/reference/method/Mongo.watch.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,8 +145,7 @@ Definition
145145
- document
146146

147147
- Optional. Pass a :ref:`collation document <collation-document-fields>`
148-
to specify a :doc:`collation </reference/collation>` for the
149-
change stream cursor.
148+
to specify collation for the change stream cursor.
150149

151150
If omitted, defaults to ``simple`` binary comparison.
152151

0 commit comments

Comments
 (0)