Skip to content

Commit 55c7a6c

Browse files
authored
DOCSP-26454 :doc:s command line - document validation (#7089)
1 parent 17fc8c7 commit 55c7a6c

30 files changed

+41
-41
lines changed

source/administration/configuration.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ Run-time Database Configuration
1212
:depth: 1
1313
:class: singlecol
1414

15-
The :doc:`command line </reference/program/mongod>` and :doc:`configuration
16-
file </reference/configuration-options>` interfaces provide MongoDB
15+
The :ref:`command line <mongod>` and :ref:`configuration file
16+
<configuration-file>` interfaces provide MongoDB
1717
administrators with a large number of options and settings for
1818
controlling the operation of the database system. This document
1919
provides an overview of common configurations and examples of
@@ -310,8 +310,8 @@ If running as a replica set, :method:`initiate <rs.initiate()>` the
310310
shard replica set and add members.
311311

312312
For the router (i.e. :binary:`~bin.mongos`), configure at least one
313-
:binary:`~bin.mongos` process with the following :doc:`setting
314-
</reference/configuration-options>`:
313+
:binary:`~bin.mongos` process with the following :ref:`setting
314+
<configuration-options>`:
315315

316316
.. code-block:: yaml
317317

source/administration/production-notes.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -681,7 +681,7 @@ WiredTiger uses :term:`prefix compression` on all indexes by default.
681681
Clock Synchronization
682682
---------------------
683683

684-
MongoDB :doc:`components </reference/program>` keep logical clocks for
684+
MongoDB :ref:`components <mongodb-package-components>` keep logical clocks for
685685
supporting time-dependent operations. Using `NTP <http://www.ntp.org/>`_
686686
to synchronize host machine clocks mitigates the risk of clock drift
687687
between components. Clock drift between components increases the

source/core/data-model-operations.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ As you create indexes, consider the following behaviors of indexes:
102102

103103
See :doc:`/applications/indexes` for more information on indexes as
104104
well as :doc:`/tutorial/analyze-query-plan/`. Additionally, the MongoDB
105-
:doc:`database profiler </tutorial/manage-the-database-profiler>` may
105+
:ref:`database profiler <database-profiler>` may
106106
help identify inefficient queries.
107107

108108
.. _data-model-large-number-of-collections:

source/crud.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ collection:
5252
In MongoDB, insert operations target a single :term:`collection`. All
5353
write operations in MongoDB are :doc:`atomic
5454
</core/write-operations-atomicity>` on the level of a single
55-
:doc:`document </core/document>`.
55+
:ref:`document <bson-document-format>`.
5656

5757
.. include:: /images/crud-annotated-mongodb-insertOne.rst
5858

source/faq/diagnostics.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,7 @@ consider the following options, depending on the nature of the impact:
276276
#. If the balancer is always migrating chunks to the detriment of
277277
overall cluster performance:
278278

279-
- You may want to attempt :doc:`decreasing the chunk size </tutorial/modify-chunk-size-in-sharded-cluster>`
279+
- You may want to attempt :ref:`decreasing the chunk size <tutorial-modifying-chunk-size>`
280280
to limit the size of the migration.
281281

282282
- Your cluster may be over capacity, and you may want to attempt to

source/includes/extracts-4.2-changes.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ content: |
129129
130130
Starting in MongoDB 4.2 (and in 4.0.9), for slow operations, the :doc:`profiler
131131
entries </tutorial/manage-the-database-profiler>` and
132-
:doc:`diagnostic log messages </reference/log-messages>` include
132+
:ref:`diagnostic log messages <log-messages-ref>` include
133133
:data:`~system.profile.storage` information.
134134
---
135135
ref: 4.2-changes-log-query-shapes-plan-cache-key
@@ -402,7 +402,7 @@ content: |
402402
will use FIPS compliant connections to
403403
:binary:`mongod` / :binary:`mongos` if the
404404
:binary:`mongod` / :binary:`mongos` instances are
405-
:doc:`configured to use FIPS mode </tutorial/configure-fips>`.
405+
:ref:`configured to use FIPS mode <configure-mdb-for-fips>`.
406406
---
407407
ref: 4.2-changes-fips-program-mongod
408408
content: |
@@ -411,7 +411,7 @@ content: |
411411
will use FIPS compliant connections to the
412412
:binary:`~bin.mongod` if the
413413
:binary:`~bin.mongod` instance is
414-
:doc:`configured to use FIPS mode </tutorial/configure-fips>`.
414+
:ref:`configured to use FIPS mode <configure-mdb-for-fips>`.
415415
416416
---
417417
ref: 4.2-changes-fips
@@ -431,7 +431,7 @@ content: |
431431
The programs will use FIPS compliant connections to
432432
:binary:`mongod` / :binary:`mongos` if the
433433
:binary:`mongod` / :binary:`mongos` instances are
434-
:doc:`configured to use FIPS mode </tutorial/configure-fips>`.
434+
:ref:`configured to use FIPS mode <configure-mdb-for-fips>`.
435435
---
436436
ref: 4.2-changes-count-syntax-validation
437437
content: |

source/includes/extracts-bypassDocumentValidation-base.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ ref: _bypassDocValidation
22
content: |
33
The {{role}} {{interface}} adds support for the
44
``bypassDocumentValidation`` option, which lets you bypass
5-
:doc:`document validation </core/schema-validation>` when
5+
:ref:`document validation <schema-validation-overview>` when
66
inserting or updating documents in a collection with validation
77
rules.
88
...

source/includes/extracts-create-cmd.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ content: |
4141
4242
A user with the :authrole:`readWrite` built in role on the database
4343
has the required privileges to run the listed operations. Either
44-
:doc:`create a user </tutorial/create-users>` with the required role
44+
:ref:`create a user <create-users>` with the required role
4545
or :ref:`grant the role to an existing user
4646
<modify-existing-user-access>`.
4747
replacement:

source/includes/extracts-views.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ content: |
114114
115115
A user with the :authrole:`readWrite` built in role on the database
116116
has the required privileges to run the listed operations. Either
117-
:doc:`create a user </tutorial/create-users>` with the required role
117+
:ref:`create a user <create-users>` with the required role
118118
or :ref:`grant the role to an existing user
119119
<modify-existing-user-access>`
120120
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Starting in MongoDB 5.0, you must explicitly set the global default
22
:ref:`write concern <write-concern>` before attempting to reconfigure a
33
:term:`replica set <replica set>` with a
4-
:doc:`configuration </reference/replica-configuration>`
4+
:ref:`configuration <replica-set-configuration-settings>`
55
that would change the implicit default write concern. To set the global
66
default write concern, use the :dbcommand:`setDefaultRWConcern` command.

source/includes/steps-deploy-replica-set-with-auth.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ action:
6262
mongod --config <path-to-config-file>
6363
post: |
6464
For more information on the configuration file, see
65-
:doc:`configuration options </reference/configuration-options>`.
65+
:ref:`configuration options <configuration-options>`.
6666
- heading: Command Line
6767
pre: |
6868
If using the command line options, start the :binary:`~bin.mongod` with the following options:

source/includes/steps-enable-authentication-in-replica-set-no-downtime.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ action:
254254
post: |
255255
256256
For more information on the configuration file, see
257-
:doc:`configuration options</reference/configuration-options>`.
257+
:ref:`configuration options <configuration-options>`.
258258
259259
post: |
260260
@@ -341,7 +341,7 @@ action:
341341
mongod --config <path-to-config-file>
342342
post: |
343343
For more information on the configuration file, see
344-
:doc:`configuration options</reference/configuration-options>`.
344+
:ref:`configuration options <configuration-options>`.
345345
346346
post: |
347347
@@ -413,7 +413,7 @@ action:
413413
post: |
414414
415415
For more information on the configuration file, see
416-
:doc:`configuration options</reference/configuration-options>`.
416+
:ref:`configuration options <configuration-options>`.
417417
418418
post: |
419419
You can also use the equivalent :binary:`~bin.mongod` options when starting your
@@ -499,7 +499,7 @@ action:
499499
mongod --config <path-to-config-file>
500500
post: |
501501
For more information on the configuration file, see
502-
:doc:`configuration options</reference/configuration-options>`.
502+
:ref:`configuration options <configuration-options>`.
503503
504504
post: |
505505
You can also use the equivalent :binary:`~bin.mongod` options when starting your

source/includes/steps-kerberos-auth-activedirectory-authz.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ ref: security-kerberos-activedirectory-authauthz-configfile
169169
level: 4
170170
pre: |
171171
172-
A MongoDB :doc:`configuration file </administration/configuration>` is a
172+
A MongoDB :ref:`configuration file <configuration-file>` is a
173173
plain-text YAML file with the ``.conf`` file extension.
174174
175175
* If you are upgrading an existing MongoDB deployment, copy the

source/includes/steps-start-sharded-cluster.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ action:
8686
mongos --config <path-to-config>
8787
post: |
8888
For more information on the configuration file, see
89-
:doc:`configuration options</reference/configuration-options>`.
89+
:ref:`configuration options <configuration-options>`.
9090
- pre: |
9191
**Command Line**
9292

source/reference/command/getAuditConfig.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,5 +124,5 @@ has a filter which captures the desired operations and the
124124
.. seealso::
125125

126126
:method:`db.adminCommand`, :dbcommand:`setAuditConfig`,
127-
:doc:`configure audit filters</tutorial/configure-audit-filters>`
127+
:ref:`configure audit filters <audit-filter>`
128128

source/reference/glossary.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -661,7 +661,7 @@ Glossary
661661
:ref:`geospatial-indexes-store-geojson`.
662662

663663
lock
664-
MongoDB uses locks to ensure that :doc:`concurrency </faq/concurrency>`
664+
MongoDB uses locks to ensure that :ref:`concurrency <faq-concurrency>`
665665
does not affect correctness. MongoDB uses :term:`read locks
666666
<read lock>`, :term:`write locks <write lock>` and
667667
:term:`intent locks <intent lock>`. For more information, see
@@ -1143,7 +1143,7 @@ Glossary
11431143

11441144
shell helper
11451145
A method in ``mongosh`` that has a concise
1146-
syntax for a :doc:`database command <command>`. Shell helpers
1146+
syntax for a :ref:`database command <database-commands>`. Shell helpers
11471147
improve the interactive experience. See
11481148
:doc:`/reference/method`.
11491149

source/reference/method.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -595,7 +595,7 @@ Database
595595

596596
* - :method:`db.runCommand()`
597597

598-
- Runs a :doc:`database command </reference/command>`.
598+
- Runs a :ref:`database command <database-commands>`.
599599

600600
* - :method:`db.serverBuildInfo()`
601601

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ Type Bracketing
170170
MongoDB treats some data types as equivalent for comparison purposes.
171171
For instance, numeric types undergo conversion before comparison. For
172172
most data types, however,
173-
:doc:`comparison operators</reference/operator/query-comparison>` only
173+
:ref:`comparison operators <query-selectors-comparison>` only
174174
perform comparisons on documents where the
175175
:ref:`BSON type <bson-types-comparison-order>` of the
176176
target field matches the type of the query operand. Consider the
@@ -1091,4 +1091,4 @@ Learn More
10911091
- :method:`~db.collection.findOne()`
10921092
- :method:`~db.collection.findAndModify()`
10931093
- :method:`~db.collection.findOneAndDelete()`
1094-
- :method:`~db.collection.findOneAndReplace()`
1094+
- :method:`~db.collection.findOneAndReplace()`

source/reference/method/db.currentOp.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ are equivalent:
133133
db.currentOp( { "$all": true } )
134134

135135
:method:`db.currentOp` and the
136-
:doc:`database profiler</reference/database-profiler>` report the same
136+
:ref:`database profiler <database-profiler>` report the same
137137
basic diagnostic information for all CRUD operations, including the
138138
following:
139139

source/reference/method/js-database.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Database Methods
147147

148148
* - :method:`db.runCommand()`
149149

150-
- Runs a :doc:`database command </reference/command>`.
150+
- Runs a :ref:`database command <database-commands>`.
151151

152152
* - :method:`db.serverBuildInfo()`
153153

source/reference/method/rs.reconfig.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Definition
5050

5151
- document
5252

53-
- A :doc:`document </reference/replica-configuration>` that specifies
53+
- A :ref:`document <replica-set-configuration-settings>` that specifies
5454
the configuration of a replica set.
5555

5656
* - .. _rs-reconfig-method-force:

source/reference/method/rs.reconfigForPSASet.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ The :method:`rs.reconfigForPSASet()` method has the following syntax:
7575

7676
- document
7777

78-
- A :doc:`document </reference/replica-configuration>` that
78+
- A :ref:`document <replica-set-configuration-settings>` that
7979
specifies the new configuration of a replica set.
8080

8181
* - ``force``

source/release-notes/3.4.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1184,7 +1184,7 @@ MongoDB 3.4 includes the following enhancements:
11841184
megabytes per batch <cursor-batches>`.
11851185

11861186
:method:`db.currentOp` and the
1187-
:doc:`database profiler</reference/database-profiler>` report the same
1187+
:ref:`database profiler <database-profiler>` report the same
11881188
basic diagnostic information for all CRUD operations, including the
11891189
following:
11901190

source/release-notes/3.6.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -927,7 +927,7 @@ JSON Schema
927927
-----------
928928

929929
MongoDB 3.6 adds the :query:`$jsonSchema` operator to support
930-
:doc:`document validation </core/schema-validation>` using JSON
930+
:ref:`document validation <schema-validation-overview>` using JSON
931931
Schema. For details, see :query:`$jsonSchema`.
932932

933933
To use :query:`$jsonSchema`, ``featureCompatibilityVersion`` must be

source/release-notes/4.2.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1660,7 +1660,7 @@ Logging
16601660

16611661
- MongoDB 4.2 adds a ``usedDisk`` indicator to the :doc:`profiler log
16621662
messages </tutorial/manage-the-database-profiler>` and
1663-
:doc:`diagnostic log messages </reference/log-messages>` for the
1663+
:ref:`diagnostic log messages <log-messages-ref>` for the
16641664
:dbcommand:`aggregate` operation. The ``usedDisk`` indicates whether
16651665
any stages of an :dbcommand:`aggregate` operation wrote data to
16661666
temporary files due to memory restrictions. For more information on

source/release-notes/4.4.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2454,7 +2454,7 @@ New ``replanReason`` Database Profiler Output Field
24542454
MongoDB 4.4 adds the :data:`replanReason<system.profile.replanReason>`
24552455
field to
24562456
:doc:`database profiler output </tutorial/manage-the-database-profiler>`
2457-
and :doc:`diagnostic log messages </reference/log-messages>`. The
2457+
and :ref:`diagnostic log messages <log-messages-ref>`. The
24582458
``replanReason`` field contains the reason the query system evicted a
24592459
:ref:`cached plan <query-plans-query-optimization>`.
24602460

source/tutorial/configure-linux-iptables-firewall.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ following two chains:
3737
``OUTPUT``
3838
Controls all outgoing traffic.
3939

40-
Given the :doc:`default ports </reference/default-mongodb-port>` of all
40+
Given the :ref:`default ports <default-mongodb-port>` of all
4141
MongoDB processes, you must configure networking rules that permit *only*
4242
required communication between your application and the appropriate
4343
:binary:`~bin.mongod` and :binary:`~bin.mongos` instances.

source/tutorial/configure-windows-netsh-firewall.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ by rule type, and parsed in the following order:
4848
By default, the policy in :guilabel:`Windows Firewall` allows all outbound connections
4949
and blocks all incoming connections.
5050

51-
Given the :doc:`default ports </reference/default-mongodb-port>` of all
51+
Given the :ref:`default ports <default-mongodb-port>` of all
5252
MongoDB processes, you must configure networking rules that permit *only*
5353
required communication between your application and the appropriate
5454
:binary:`mongod.exe` and :binary:`mongos.exe` instances.

source/tutorial/deploy-shard-cluster.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ command line parameter to specify the config servers.
155155
mongos --config <path-to-config>
156156

157157
For more information on the configuration file, see
158-
:doc:`configuration options</reference/configuration-options>`.
158+
:ref:`configuration options <configuration-options>`.
159159

160160
.. tab:: Command Line
161161
:tabid: command-line

source/tutorial/evaluate-operation-performance.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ performance.
1616
Use the Database Profiler to Evaluate Operations Against the Database
1717
---------------------------------------------------------------------
1818

19-
MongoDB provides a :doc:`database profiler </tutorial/manage-the-database-profiler>` that shows performance
19+
MongoDB provides a :ref:`database profiler <database-profiler>` that shows performance
2020
characteristics of each operation against the database. Use the profiler
2121
to locate any queries or write operations that are running slow. You can
2222
use this information, for example, to determine what indexes to create.

0 commit comments

Comments
 (0)