Skip to content

Commit 080523a

Browse files
authored
DOCSP-26448 Replace Text Indexes-YAML Docs (mongodb#2292)
* DOCSP-26448 replace docs * fix broken ref * fix another broken ref * removed extra link
1 parent 898a0b1 commit 080523a

25 files changed

+30
-28
lines changed

source/core/data-model-operations.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ Data Lifecycle Management
245245
Data modeling decisions should take data lifecycle management into
246246
consideration.
247247

248-
The :doc:`Time to Live or TTL feature </tutorial/expire-data>` of
248+
The :ref:`Time to Live or TTL feature <ttl-collections>` of
249249
collections expires documents after a period of time. Consider using
250250
the TTL feature if your application requires some data to persist in
251251
the database for a limited period of time.

source/core/index-creation.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Constraint Violations During Index Build
7272
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7373

7474
For indexes that enforce constraints on the collection, such as
75-
:doc:`unique </core/index-unique>` indexes, the :binary:`~bin.mongod`
75+
:ref:`unique <index-type-unique>` indexes, the :binary:`~bin.mongod`
7676
checks all pre-existing and concurrently-written documents for
7777
violations of those constraints *after* the index build completes.
7878
Documents that violate the index constraints can exist during the index

source/core/index-multikey.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ special rules. For details on multikey index bounds, see
5757
Unique Multikey Index
5858
---------------------
5959

60-
For :doc:`unique </core/index-unique>` indexes, the unique constraint
60+
For :ref:`unique <index-type-unique>` indexes, the unique constraint
6161
applies across separate documents in the collection rather than within
6262
a single document.
6363

source/core/index-unique.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ You cannot specify a unique constraint on a :ref:`hashed index
248248
<index-type-hashed>`.
249249

250250
For a ranged sharded collection, only the following indexes can be
251-
:doc:`unique </core/index-unique>`:
251+
:ref:`unique <index-type-unique>`:
252252

253253
- the index on the shard key
254254

source/core/inmemory.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ In-memory storage engine requires that all its data (including indexes,
8181
oplog if :binary:`~bin.mongod` instance is part of a replica set, etc.) must
8282
fit into the specified :option:`--inMemorySizeGB <mongod --inMemorySizeGB>` command-line option
8383
or :setting:`storage.inMemory.engineConfig.inMemorySizeGB` setting in
84-
the :doc:`YAML configuration file </reference/configuration-options>`.
84+
the :ref:`YAML configuration file <configuration-options>`.
8585

8686
.. include:: /includes/fact-inmemory-storage-engine-default-ram.rst
8787

source/core/journaling.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Journaling and the WiredTiger Storage Engine
2525
The *log* mentioned in this section refers to the WiredTiger
2626
write-ahead log (i.e. the journal) and not the MongoDB log file.
2727

28-
:doc:`WiredTiger </core/wiredtiger>` uses :ref:`checkpoints
28+
:ref:`WiredTiger <storage-wiredtiger>` uses :ref:`checkpoints
2929
<storage-wiredtiger-checkpoints>` to provide a consistent view of data
3030
on disk and allow MongoDB to recover from the last checkpoint. However,
3131
if MongoDB exits unexpectedly in between checkpoints, journaling is

source/core/retryable-writes.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Supported Deployment Topologies
3030

3131
Supported Storage Engine
3232
Retryable writes require a storage engine supporting document-level
33-
locking, such as the :doc:`WiredTiger </core/wiredtiger>` or
33+
locking, such as the :ref:`WiredTiger <storage-wiredtiger>` or
3434
:doc:`in-memory </core/inmemory>` storage engines.
3535

3636
3.6+ MongoDB Drivers

source/core/security-ldap.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@ file settings:
350350

351351
Include any other configuration file settings required for your
352352
deployment. For complete documentation on configuration files, see
353-
:doc:`YAML configuration file </reference/configuration-options>`.
353+
:ref:`YAML configuration file <configuration-options>`.
354354

355355
You need to create or update the ``saslauthd.conf`` file with the parameters
356356
appropriate for your LDAP server. Documenting ``saslauthd.conf`` is out

source/core/sharding-shard-key.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ uniqueness on the entire key combination and not individual components
6161
of the shard key.
6262

6363
For a ranged sharded collection, only the following indexes can be
64-
:doc:`unique </core/index-unique>`:
64+
:ref:`unique <index-type-unique>`:
6565

6666
- the index on the shard key
6767

source/core/storage-engines.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ applications.
2424
.. include:: /includes/fact-4.2-mmapv1-removed.rst
2525

2626
|arrow| WiredTiger Storage Engine (*Default*)
27-
:doc:`WiredTiger </core/wiredtiger>` is the default storage engine
27+
:ref:`WiredTiger <storage-wiredtiger>` is the default storage engine
2828
starting in MongoDB 3.2. It is well-suited for most workloads and is
2929
recommended for new deployments. WiredTiger provides a
3030
document-level concurrency model, checkpointing, and compression,

source/core/transactions.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -388,7 +388,7 @@ For a list of operations not supported in transactions, see
388388

389389
.. seealso::
390390

391-
:doc:`Transactions and Operations Reference </core/transactions-operations>`
391+
:ref:`Transactions and Operations Reference <transactions-operations-ref>`
392392

393393
.. _transactions-create-collections-indexes:
394394

@@ -499,7 +499,7 @@ Restricted Operations
499499

500500
- :ref:`txn-prod-considerations-ddl`
501501

502-
- :doc:`Transactions and Operations Reference </core/transactions-operations>`
502+
- :ref:`Transactions and Operations Reference <transactions-operations-ref>`
503503

504504
Transactions and Sessions
505505
-------------------------

source/core/workload-isolation.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ documentation in the MongoDB Manual:
5353
- :ref:`Read Preferences <read-preference>`, which controls how drivers
5454
help applications target read operations to members of a replica set.
5555

56-
- :doc:`Write Concerns </reference/write-concern>`, which controls
56+
- :ref:`Write Concerns <write-concern>`, which controls
5757
how MongoDB ensures that write operations propagate to members of a
5858
replica set.
5959

source/core/write-performance.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ performance:
8080
number of available I/O resources. Moving the journal to a
8181
separate device may increase the capacity for write operations.
8282

83-
- If applications specify :doc:`write concerns </reference/write-concern>`
83+
- If applications specify :ref:`write concerns <write-concern>`
8484
that include the :writeconcern:`j option <j>`,
8585
:binary:`~bin.mongod` will decrease the duration between journal
8686
writes, which can increase the overall write load.

source/faq/concurrency.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ also yield locks between individual document modifications in write
115115
operations that affect multiple documents.
116116

117117
For storage engines supporting document level :term:`concurrency
118-
control`, such as :doc:`WiredTiger </core/wiredtiger>`, yielding is not
118+
control`, such as :ref:`WiredTiger <storage-wiredtiger>`, yielding is not
119119
necessary when accessing storage as the :term:`intent locks <intent
120120
lock>`, held at the global, database and collection level, do not block
121121
other readers and writers. However, operations will periodically yield,

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ content: |
3838
3939
Downgrade first ``confserver3``, then ``confserver2``, and lastly,
4040
``confserver1``. If your :binary:`~bin.mongod` instance is using the
41-
:doc:`WiredTiger </core/wiredtiger>` storage engine, you must
41+
:ref:`WiredTiger <storage-wiredtiger>` storage engine, you must
4242
include the :option:`--storageEngine <mongod --storageEngine>` option (or
4343
:setting:`storage.engine` if using the configuration file) with the
4444
3.0 binary.

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ content: |
239239
240240
For each replica set shard, downgrade the :binary:`~bin.mongod` binaries
241241
and restart. If your :binary:`~bin.mongod` instance is using the
242-
:doc:`WiredTiger </core/wiredtiger>` storage engine, you must include
242+
:ref:`WiredTiger <storage-wiredtiger>` storage engine, you must include
243243
the :option:`--storageEngine <mongod --storageEngine>` option (or :setting:`storage.engine` if
244244
using the configuration file) with the 3.0 binary.
245245

source/introduction.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ operations (CRUD) <crud>` as well as:
6767

6868
- :ref:`Data Aggregation <aggregation-pipeline>`
6969

70-
- :doc:`Text Search </text-search>` and :doc:`Geospatial Queries
70+
- :ref:`Text Search <text-search>` and :doc:`Geospatial Queries
7171
</tutorial/geospatial-tutorial>`.
7272

7373
.. seealso::

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ index types.
175175
Unexpected Shutdown and Count
176176
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
177177

178-
For MongoDB instances using the :doc:`WiredTiger </core/wiredtiger>`
178+
For MongoDB instances using the :ref:`WiredTiger <storage-wiredtiger>`
179179
storage engine, after an unclean shutdown, statistics on size and count
180180
may off by up to 1000 documents as reported by :dbcommand:`collStats`,
181181
:dbcommand:`dbStats`, :dbcommand:`count`. To restore the correct

source/reference/operator/aggregation/merge.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -751,7 +751,7 @@ Restrictions
751751
- An aggregation pipeline cannot use :pipeline:`$merge` inside a
752752
:ref:`transaction <transactions-operations-crud>`.
753753

754-
* - :doc:`Time Series Collections </core/timeseries-collections>`
754+
* - :ref:`Time Series Collections <manual-timeseries-landing>`
755755

756756
- An aggregation pipeline cannot use :pipeline:`$merge` to output to
757757
a time series collection.

source/reference/operator/aggregation/out.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ Restrictions
238238
- An aggregation pipeline cannot use :pipeline:`$out` inside
239239
:ref:`transactions <transactions>`.
240240

241-
* - :doc:`Time Series Collections </core/timeseries-collections>`
241+
* - :ref:`Time Series Collections <manual-timeseries-landing>`
242242

243243
- An aggregation pipeline cannot use :pipeline:`$out` to output to
244244
a time series collection.

source/release-notes/3.0-upgrade.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ authentication and authorization, your user data model ``authSchema``
4444
must be at least version 3. To verify the version of your existing
4545
``authSchema``, see :ref:`legacy-auth-model-removed`. To upgrade your
4646
``authSchema`` version, see
47-
:doc:`Upgrade Authorization Data </release-notes/2.6-upgrade-authorization>` for details.
47+
:ref:`Upgrade Authorization Data <2.6-upgrade-authorization-model>` for details.
4848

4949
Preparedness
5050
~~~~~~~~~~~~

source/text-search.txt

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _text-search:
2+
13
===========
24
Text Search
35
===========
@@ -43,8 +45,8 @@ string content. To perform text search, MongoDB uses a :ref:`text index
4345

4446
To learn more about text search for on-premises deployments, see:
4547

46-
- :doc:`Text Indexes </core/link-text-indexes/>`
47-
- :doc:`Text Search Operators </core/text-search-operators/>`
48+
- :ref:`Text Indexes <text-search-on-premises>`
49+
- :ref:`Text Search Operators <text-search-operators-on-premises>`
4850

4951
MongoDB also supports text search for various languages. See
5052
:doc:`/reference/text-search-languages` for a list of supported

source/tutorial/backup-with-filesystem-snapshots.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ WiredTiger Storage Engine
5151
~~~~~~~~~~~~~~~~~~~~~~~~~
5252

5353
MongoDB 3.2 added support for volume-level back up of MongoDB instances
54-
using the :doc:`WiredTiger </core/wiredtiger>` storage engine when
54+
using the :ref:`WiredTiger <storage-wiredtiger>` storage engine when
5555
the MongoDB instance's data files and journal files reside on separate
5656
volumes. However, to create a coherent backup, the database must be locked
5757
and all writes to the database must be suspended during the backup process.
@@ -75,7 +75,7 @@ disk: either to the :term:`journal` or to data files.
7575
If there are writes that are not on disk when the backup occurs, the backup
7676
will not reflect these changes.
7777

78-
For the :doc:`WiredTiger storage engine </core/wiredtiger>`, the data
78+
For the WiredTiger storage engine, the data
7979
files reflect a consistent state as of the last :ref:`checkpoint
8080
<storage-wiredtiger-checkpoints>`. Checkpoints occur with every 2 GB of
8181
data or every minute.

source/tutorial/deploy-sharded-cluster-with-keyfile-access-control.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Enforcing access control on a :term:`sharded cluster` requires configuring:
1919
:ref:`Internal Authentication<replica-set-security>`.
2020

2121
- Security between connecting clients and the cluster using
22-
:doc:`User Access Controls</core/authorization>`.
22+
:ref:`User Access Controls<authorization>`.
2323

2424
For this tutorial, each member of the sharded cluster *must* use the same
2525
internal authentication mechanism and settings. This means enforcing internal

source/tutorial/enforce-keyfile-access-control-in-existing-replica-set.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ configuring:
2020
:ref:`Internal Authentication<replica-set-security>`, and
2121

2222
- Security between connecting clients and the replica set using
23-
:doc:`User Access Controls</core/authorization>`.
23+
:ref:`User Access Controls<authorization>`.
2424

2525
For this tutorial, each member of the replica set uses the same internal
2626
authentication mechanism and settings.

0 commit comments

Comments
 (0)