DOCSP-26416 Updates TTL-related doc directives (#2134)

Author: jmd-mongo

source/core/capped-collections.txt

@@ -28,13 +28,12 @@ for more information on creating capped collections.
 .. tip::
 
    As an alternative to capped collections, consider MongoDB's
-   :doc:`TTL (Time To Live) indexes </core/index-ttl>`. As
-   described in :doc:`/tutorial/expire-data`, these indexes allow you
+   :ref:`TTL (Time To Live) indexes <index-feature-ttl>`. As
+   described in :ref:`ttl-collections`, these indexes allow you
    to expire and remove data from normal collections based on the value
    of a date-typed field and a TTL value for the index.
 
-   :doc:`TTL indexes </tutorial/expire-data>` are not compatible
-   with capped collections.
+   TTL indexes are not compatible with capped collections.
 
 
 Behavior

source/core/index-hidden.txt

@@ -27,12 +27,12 @@ Behavior
 --------
 
 Apart from being hidden from the planner, hidden indexes behave like
-unhidden indexes; i.e.
+unhidden indexes. For example:
 
 - If a hidden index is a :doc:`unique index </core/index-unique>`, the
   index still applies its unique constraint to the documents.
 
-- If a hidden index is a :doc:`TTL index </core/index-ttl>`, the index
+- If a hidden index is a :ref:`TTL index <index-feature-ttl>`, the index
   still expires documents.
 
 - Hidden indexes are included in :dbcommand:`listIndexes` and

source/core/index-wildcard.txt

@@ -203,7 +203,7 @@ Considerations
 - A wildcard index may cover the same fields as other indexes in the 
   collection.
 
-- Wildcard indexes are :doc:`/core/index-sparse` and only contain 
+- Wildcard indexes are :ref:`index-type-sparse` and only contain 
   entries for documents that have the indexed field, even if the index 
   field contains a null value.
 
@@ -391,18 +391,18 @@ Restrictions
   For more information on shard key selection, see
   :ref:`sharding-shard-key`.
 
-- You cannot create a :doc:`compound </core/index-compound>` index.
+- You cannot create a :ref:`compound <index-type-compound>` index.
 
 - You cannot specify the following properties for a wildcard index:
 
-  - :doc:`TTL </core/index-ttl>`
-  - :doc:`Unique </core/index-unique>`
+  - :ref:`TTL <index-feature-ttl>`
+  - :ref:`Unique <index-type-unique>`
 
 - You cannot create the following index types using wildcard syntax:
 
-  - :doc:`2d (Geospatial) </core/geospatial-indexes>`
-  - :doc:`2dsphere (Geospatial) </core/2dsphere>`
-  - :doc:`Hashed </core/index-hashed>`
+  - :ref:`2d (Geospatial) <2d-index-internals>`
+  - :ref:`2dsphere (Geospatial) <2dsphere-index>`
+  - :ref:`Hashed <index-type-hashed>`
 
 .. important::
 

source/includes/driver-examples/driver-example-modify-index-tabs.rst

@@ -5,7 +5,7 @@
        content: |
          To modify an existing index in the MongoDB Shell, you need to
          drop and recreate the index. The exception to this rule is
-         :doc:`TTL indexes </core/index-ttl/>`, which can be modified
+         :ref:`TTL indexes <index-feature-ttl>`, which can be modified
          via the :dbcommand:`collMod` command in conjunction with the
          :collflag:`index` collection flag.
 

source/includes/extracts-wildcard-indexes.yaml

@@ -84,13 +84,13 @@ content: |
   Wildcard indexes do not support the following index types or
   properties:
 
-  - :doc:`Compound </core/index-compound>`
-  - :doc:`TTL </core/index-ttl>`
+  - :ref:`Compound <index-type-compound>`
+  - :ref:`TTL <index-feature-ttl>`
   - :ref:`text <index-feature-text>`
-  - :doc:`2d (Geospatial) </core/geospatial-indexes>`
-  - :doc:`2dsphere (Geospatial) </core/2dsphere>`
-  - :doc:`Hashed </core/index-hashed>`
-  - :doc:`Unique </core/index-unique>`
+  - :ref:`2d (Geospatial) <2d-index-internals>`
+  - :ref:`2dsphere (Geospatial) <2dsphere-index>`
+  - :ref:`Hashed <index-type-hashed>`
+  - :ref:`Unique <index-type-unique>`
 
   .. note::
 

source/indexes.txt

@@ -246,7 +246,7 @@ field(s) and skip indexing documents that lack the indexed field(s).
 TTL Indexes
 ~~~~~~~~~~~
 
-:doc:`TTL indexes </core/index-ttl>` are special indexes that MongoDB
+:ref:`TTL indexes <index-feature-ttl>` are special indexes that MongoDB
 can use to automatically remove documents from a collection after a
 certain amount of time. This is ideal for certain types of information
 like machine generated event data, logs, and session information that

source/reference/glossary.txt

@@ -797,8 +797,8 @@ Glossary
       A per-collection setting that changes and normalizes the way
       MongoDB allocates space for each :term:`document`, in an effort to
       maximize storage reuse and to reduce fragmentation. This is the
-      default for :doc:`TTL Collections </tutorial/expire-data>`. See
-      :doc:`/reference/command/collMod`.
+      default for :ref:`TTL Collections <ttl-collections>`. See
+      :dbcommand:`collMod`.
 
    prefix compression
       Reduces memory and disk consumption by storing any identical index

source/reference/parameters.txt

@@ -1339,7 +1339,7 @@ General Parameters
 
    *Default*: ``true``
 
-   To support :doc:`TTL Indexes </core/index-ttl>`, :binary:`~bin.mongod`
+   To support :ref:`TTL Indexes <index-feature-ttl>`, :binary:`~bin.mongod`
    instances have a background thread that is responsible for deleting
    documents from collections with TTL indexes.
 
@@ -1363,8 +1363,7 @@ General Parameters
       Do not run production :binary:`~bin.mongod` instances with
       ``ttlMonitorEnabled`` disabled, except under guidance from MongoDB
       support. Preventing TTL document removal can negatively impact
-      MongoDB internal system operations that depend on
-      :doc:`TTL Indexes </core/index-ttl>`.
+      MongoDB internal system operations that depend on TTL Indexes.
 
 .. parameter:: tcpFastOpenServer
 

source/tutorial/expire-data.txt

@@ -22,7 +22,7 @@ Data expiration is useful for some classes of information, including
 machine generated event data, logs, and session information that only
 need to persist for a limited period of time.
 
-A special :doc:`TTL index property </core/index-ttl>` supports the
+A special :ref:`TTL index property <index-feature-ttl>` supports the
 implementation of TTL collections. The TTL feature relies on a
 background thread in :binary:`~bin.mongod` that reads the date-typed values
 in the index and removes expired :term:`documents <document>` from the
@@ -31,7 +31,7 @@ collection.
 Procedures
 ----------
 
-To create a :doc:`TTL index </core/index-ttl>`, use the
+To create a :ref:`TTL index <index-feature-ttl>`, use the
 :method:`db.collection.createIndex()` method with the
 ``expireAfterSeconds`` option on a field whose value is either a
 :ref:`date <document-bson-type-date>` or an array that contains
@@ -41,7 +41,7 @@ To create a :doc:`TTL index </core/index-ttl>`, use the
 
    The TTL index is a single field index. Compound indexes do not
    support the TTL property. For more information on TTL indexes, see
-   :doc:`/core/index-ttl`.
+   :ref:`index-feature-ttl`.
 
 You can modify the ``expireAfterSeconds`` of an existing TTL index
 using the :dbcommand:`collMod` command.