DOCSP-26321 updates collation-related doc directives (#2112)

Author: jmd-mongo

source/includes/extracts-views.yaml

@@ -64,7 +64,7 @@ replacement:
 ref: views-collation-behavior
 content: |
 
-   - You can specify a default :doc:`collation </reference/collation>`
+   - You can specify a default :ref:`collation <collation>`
      for a view at creation time. If no collation is specified, the
      view's default collation is the "simple" binary comparison
      collator. That is, the view does not inherit the collection's
@@ -84,7 +84,7 @@ content: |
 
    If performing an aggregation that involves multiple views, such as
    with :pipeline:`$lookup` or :pipeline:`$graphLookup`, the views must
-   have the same :doc:`collation  </reference/collation>`.
+   have the same :ref:`collation <collation>`.
 ---
 ref: views-public-definition
 content: |

source/includes/fact-shardCollection-collation.rst

@@ -1,9 +1,7 @@
 Collation
 ~~~~~~~~~
 
-.. versionchanged:: 3.4
-
-If the collection has a default :doc:`collation</reference/collation>`,
+If the collection has a default :ref:`collation <collation>`,
 the |command| command must include a ``collation`` parameter with the
 value ``{ locale: "simple" }``. For non-empty collections with a
 default collation, you must have at least one index with the simple

source/includes/note-sharding-collation.rst

@@ -3,4 +3,4 @@
    Queries on the sharded collection continue to use the default
    collation configured for the collection. To use the shard key
    index's ``simple`` collation, specify ``{locale : "simple"}``
-   in the query's :doc:`collation document </reference/collation>`.
+   in the query's :ref:`collation document <collation>`.

source/indexes.txt

@@ -291,8 +291,8 @@ Indexes and Collation
 
 .. include:: /includes/extracts/collation-index-use.rst
 
-For more information on collation, see the :doc:`collation reference
-page </reference/collation/>`.
+For more information on collation, see the :ref:`collation reference
+page <collation>`.
 
 .. include:: /includes/extracts/collation-index-type-restrictions.rst
 

source/reference/collation-locales-defaults.txt

@@ -17,16 +17,15 @@ Behavior
 
 .. include:: /includes/collation-variants.rst
 
-See the :doc:`collation page</reference/collation>` for a full
-description of collation behavior and syntax.
+See the :ref:`collation page <collation>` for a full description of 
+collation behavior and syntax.
 
 .. _collation-languages-locales:
 
 Supported Languages and Locales
 -------------------------------
 
-MongoDB's :doc:`collation feature</reference/collation>` supports
-the following languages. The
+MongoDB's collation feature supports the following languages. The
 following table lists the supported languages and the associated
 locales as defined by `ICU Locale
 ID <http://userguide.icu-project.org/locale>`_. [#missing-locale]_
@@ -52,7 +51,7 @@ A collation document contains several
 :ref:`optional parameters<collation-document-fields>` in
 addition to the required ``locale`` parameter. Depending on which
 ``locale`` you use, the default parameters may be different.
-See the :doc:`collation page</reference/collation>` for a
+See the :ref:`collation page <collation>` for a
 full description of collation syntax.
 
 The following default parameters are consistent across all locales:

source/reference/command/refineCollectionShardKey.txt

@@ -178,7 +178,7 @@ Index Considerations
 
 - Index Collation
       If the sharded collection has a non-``simple`` default
-      :doc:`collation </reference/collation>`, then the index *must* include a
+      :ref:`collation <collation>`, then the index *must* include a
       collation document with ``{ locale : "simple" }``. At least one
       of the indexes whose fields support the shard key pattern must
       have the simple collation.
@@ -239,7 +239,7 @@ Collection with non-``simple`` Collation
 To set up the example in the ``test`` database:
 
 #. Create the ``cafés`` collection in the ``test`` database,
-   specifying French ``fr`` as the default :doc:`collation </reference/collation>`.
+   specifying French ``fr`` as the default collation.
 
    .. code-block:: javascript
 
@@ -264,9 +264,8 @@ To modify the shard key to be both the ``customer_id`` field and the
 
 #. :method:`Create the index <db.collection.createIndex()>` to
    support the new shard key if the index does not already exist.
-   Because the collection uses a non-simple :doc:`collation
-   </reference/collation>`, the index must include the ``collation:
-   { locale: "simple" }`` option.
+   Because the collection uses a non-simple collation, the index
+   must include the ``collation: { locale: "simple" }`` option.
 
    .. code-block:: javascript
 

source/reference/command/reshardCollection.txt

@@ -97,10 +97,9 @@ The command takes the following fields:
    * - ``collation``
      - document
      - Optional. If the collection specified to ``reshardCollection``
-       has a default :doc:`collation </reference/collation>`,
-       you *must* include a collation document with
-       ``{ locale : "simple" }``, or the ``reshardCollection``
-       command fails.
+       has a default :ref:`collation <collation>`, you *must* include a 
+       collation document with ``{ locale : "simple" }``, or the 
+       ``reshardCollection`` command fails.
 
    * - ``zones``
      - array

source/reference/command/shardCollection.txt

@@ -130,10 +130,9 @@ The command takes the following fields:
    * - ``collation``
      - document
      - Optional. If the collection specified to ``shardCollection``
-       has a default :doc:`collation </reference/collation>`,
-       you *must* include a collation document with
-       ``{ locale : "simple" }``, or
-       the ``shardCollection`` command fails. At least one of the indexes
+       has a default :ref:`collation <collation>`, you *must* include a 
+       collation document with ``{ locale : "simple" }``, or the 
+       ``shardCollection`` command fails. At least one of the indexes
        whose fields support the shard key pattern must have the simple
        collation.
 

source/reference/glossary.txt

@@ -873,7 +873,7 @@ Glossary
 
    query shape
       A combination of query predicate, sort, projection, and
-      :doc:`collation </reference/collation>`. The query shape allows MongoDB 
+      :ref:`collation <collation>`. The query shape allows MongoDB 
       to identify logically equivalent queries and analyze their performance.
 
       For the query predicate, only the structure of the predicate,

source/reference/method/Mongo.watch.txt

@@ -145,8 +145,7 @@ Definition
         - document
 
         - Optional. Pass a :ref:`collation document <collation-document-fields>`
-          to specify a :doc:`collation </reference/collation>` for the 
-          change stream cursor.
+          to specify collation for the change stream cursor.
 
           If omitted, defaults to ``simple`` binary comparison.
 

source/reference/method/db.collection.watch.txt

@@ -144,8 +144,7 @@ Definition
         - document
 
         - Optional. Pass a :ref:`collation document <collation-document-fields>`
-          to specify a :doc:`collation </reference/collation>` for the 
-          change stream cursor.
+          to specify a collation for the change stream cursor.
 
           Starting in MongoDB 4.2, defaults to ``simple`` binary comparison if
           omitted. In earlier versions, change streams opened on a single

source/reference/method/db.watch.txt

@@ -149,9 +149,8 @@ Definition
 
         - document
 
-        - Optional. Pass a :ref:`collation document <collation-document-fields>`
-          to specify a :doc:`collation </reference/collation>` for the 
-          change stream cursor.
+        - Optional. Pass a :ref:`collation document <collation-document-fields>` 
+          to specify a collation for the change stream cursor.
 
           If omitted, defaults to ``simple`` binary comparison.
 

source/reference/method/sh.reshardCollection.txt

@@ -101,10 +101,9 @@ The ``options`` argument supports the following options:
      - document
 
      - Optional. If the collection specified to ``reshardCollection``
-       has a default :doc:`collation </reference/collation>`,
-       you *must* include a collation document with
-       ``{ locale : "simple" }``, or the ``reshardCollection``
-       command fails.
+       has a default :ref:`collation <collation>`, you *must* include a 
+       collation document with ``{ locale : "simple" }``, or the 
+       ``reshardCollection`` command fails.
 
    * - ``zones``
 

source/reference/method/sh.shardCollection.txt

@@ -152,10 +152,9 @@ Definition
         - document
 
         - Optional. If the collection specified to ``shardCollection``
-          has a default :doc:`collation </reference/collation>`,
-          you *must* include a collation document with
-          ``{ locale : "simple" }``, or
-          the ``shardCollection`` command fails. At least one of the indexes
+          has a default :ref:`collation <collation>`, you *must* include 
+          a collation document with``{ locale : "simple" }``, or the 
+          ``shardCollection`` command fails. At least one of the indexes
           whose fields support the shard key pattern must have the simple
           collation.
 
@@ -348,7 +347,7 @@ following example uses
 - a :ref:`hashed shard key <sharding-hashed-sharding>` on the
   ``last_name`` field,
 - ``5`` initial chunks, and
-- a :doc:`collation </reference/collation>` of ``simple``. 
+- a collation of ``simple``. 
 
 .. code-block:: javascript
 

source/reference/operator/aggregation/merge.txt

@@ -194,8 +194,8 @@ The :pipeline:`$merge` takes a document with the following fields:
       specification does not matter, the unique index must only contain
       the ``on`` fields as its keys.
 
-      - The index must also have the same :doc:`collation
-        </reference/collation>` as the aggregation's collation.
+      - The index must also have the same :ref:`collation <collation>` 
+        as the aggregation's collation.
 
       - The unique index can be a :ref:`sparse <index-type-sparse>`
         index.

source/release-notes/3.4.txt

@@ -1074,14 +1074,14 @@ Collation and Case-Insensitive Indexes
 --------------------------------------
 
 To allow for language-specific rules for string comparison, MongoDB
-3.4 introduces :doc:`collation </reference/collation>` to its query language and
+3.4 introduces :ref:`collation <collation>` to its query language and
 indexes.
 
 The following operations support collation:
 
 .. include:: /includes/extracts/collation-operations-table.rst
 
-For details, see :doc:`Collation </reference/collation>`.
+For details, see :ref:`Collation <collation>`.
 
 .. [#index-restriction]