Skip to content

Commit 8b1647f

Browse files
authored
DOCSP-26426 Replaces Compound-GeoJSON doc directives (#2156)
1 parent 67f0728 commit 8b1647f

26 files changed

+35
-30
lines changed

source/administration/production-checklist-operations.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Replication
5757
- Verify that all non-hidden replica set members are identically
5858
provisioned in terms of their RAM, CPU, disk, network setup, etc.
5959

60-
- :doc:`Configure the oplog size </tutorial/change-oplog-size>` to
60+
- :ref:`Configure the oplog size <tutorial-change-oplog-size>` to
6161
suit your use case:
6262

6363
- The replication oplog window should cover normal maintenance and

source/administration/production-notes.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,7 @@ NUMA for use with MongoDB.
418418

419419
You must use ``numactl`` to start each of your
420420
:binary:`~bin.mongod` instances, including all
421-
:doc:`config servers </core/sharded-cluster-config-servers>`,
421+
:ref:`config servers <sharding-config-server>`,
422422
:binary:`~bin.mongos` instances, and clients. Edit the default
423423
**systemd** service file for each as follows:
424424

@@ -472,7 +472,7 @@ NUMA for use with MongoDB.
472472

473473
You must use ``numactl`` to start each of your
474474
:binary:`~bin.mongod` instances, including all
475-
:doc:`config servers </core/sharded-cluster-config-servers>`,
475+
:ref:`config servers <sharding-config-server>`,
476476
:binary:`~bin.mongos` instances, and clients.
477477

478478
#. Install ``numactl`` for your platform if not already

source/core/document.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Field Names
7272

7373
Field names are strings.
7474

75-
:doc:`Documents </core/document>` have the following restrictions on field
75+
:ref:`Documents <bson-document-format>` have the following restrictions on field
7676
names:
7777

7878
- .. include:: /includes/fact-id-field-name-rules.rst

source/core/sharded-cluster-components.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ A MongoDB :term:`sharded cluster` consists of the following components:
2828
can support :ref:`hedged reads <mongos-hedged-reads>` to minimize
2929
latencies.
3030

31-
* :doc:`config servers </core/sharded-cluster-config-servers>`: Config
31+
* :ref:`config servers <sharding-config-server>`: Config
3232
servers store metadata and configuration settings for the cluster. As
3333
of MongoDB 3.4, config servers must be deployed as a replica set (CSRS).
3434

source/includes/driver-examples/driver-example-update-52.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@
104104

105105
Because |compass| does not support
106106
:update:`$currentDate` or any other
107-
:doc:`Field Update Operators </reference/operator/update-field>`,
107+
:ref:`Field Update Operators <field-update-operators>`,
108108
you must manually enter the date value in Compass.
109109

110110
- id: python

source/includes/extracts-geojson-specification.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ content: |
4343
}
4444
4545
For a list of the GeoJSON objects supported in MongoDB as well as
46-
examples, see :doc:`GeoJSON objects </reference/geojson>`.
46+
examples, see :ref:`GeoJSON objects <geospatial-indexes-store-geojson>`.
4747
4848
.. include:: /includes/extracts/geojson-specification-query-calculation.rst
4949
...

source/includes/fact-sharded-cluster-components.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ A MongoDB :term:`sharded cluster` consists of the following components:
88
query router, providing an interface between client applications and the
99
sharded cluster.
1010

11-
- :doc:`config servers </core/sharded-cluster-config-servers>`: Config
11+
- :ref:`config servers <sharding-config-server>`: Config
1212
servers store metadata and configuration settings for the cluster. As
1313
of MongoDB 3.4, config servers must be deployed as a replica set (CSRS).
1414

source/includes/steps-deploy-geographically-distributed-replica-set-5member.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ content: |
5757
Alternatively, you can also specify the :setting:`replica set name
5858
<replication.replSetName>` and the :setting:`hostnames/ip
5959
addresses <net.bindIp>` in a
60-
:doc:`configuration file </reference/configuration-options>`:
60+
:ref:`configuration file <configuration-options>`:
6161
6262
.. code-block:: yaml
6363

source/includes/steps-run-mongodb-on-osx.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ pre: |
5757
from above, and the ``fork`` parameter to run :binary:`~bin.mongod`
5858
in the background. Alternatively, you may choose to store the values
5959
for ``dbpath``, ``logpath``, ``fork``, and many other parameters in a
60-
:doc:`configuration file </reference/configuration-options>`.
60+
:ref:`configuration file <configuration-options>`.
6161
action:
6262
- heading: Run ``mongod`` with command-line parameters
6363
pre: |
@@ -71,7 +71,7 @@ action:
7171
pre: |
7272
Run the :binary:`~bin.mongod` process at the system prompt,
7373
providing the path to a
74-
:doc:`configuration file </reference/configuration-options>`
74+
:ref:`configuration file <configuration-options>`
7575
with the ``config`` parameter:
7676
language: sh
7777
code: |

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ ref: stop-servers
2929
content: |
3030
3131
Run :method:`db.shutdownServer()` from the ``admin`` database on each
32-
of the :doc:`config servers </core/sharded-cluster-config-servers>` to
32+
of the :ref:`config servers <sharding-config-server>` to
3333
shutdown its :binary:`mongod <bin.mongod>` process. Shutdown all
3434
secondary members before shutting down the primary.
3535

source/introduction.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Query API
6363
The MongoDB Query API supports :doc:`read and write
6464
operations (CRUD) </crud>` as well as:
6565

66-
- :doc:`Data Aggregation </core/aggregation-pipeline>`
66+
- :ref:`Data Aggregation <aggregation-pipeline>`
6767

6868
- :doc:`Text Search </text-search>` and :doc:`Geospatial Queries
6969
</tutorial/geospatial-tutorial>`.

source/reference/bson-types.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ following table:
3636
To determine a field's type, see :ref:`check-types-in-shell`.
3737

3838
If you convert BSON to JSON, see
39-
the :doc:`Extended JSON </reference/mongodb-extended-json>` reference.
39+
the :ref:`Extended JSON <mongodb-extended-json-v2>` reference.
4040

4141
The following sections describe special considerations for particular
4242
BSON types.

source/reference/method/cursor.comment.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ following diagnostic outputs:
6262

6363
See :ref:`configure log verbosity <log-messages-configure-verbosity>` for the
6464
:binary:`~bin.mongod` log, the
65-
:doc:`Database Profiler tutorial </tutorial/manage-the-database-profiler>`, or
65+
:ref:`Database Profiler tutorial <database-profiler>`, or
6666
the :method:`db.currentOp()` command.
6767

6868
Example

source/reference/method/db.getLogComponents.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ verbosity settings. For example:
9090
To modify these settings, you can configure the
9191
:setting:`systemLog.verbosity` and
9292
``systemLog.component.<name>.verbosity`` settings in the
93-
:doc:`configuration file </reference/configuration-options>` or set the
93+
:ref:`configuration file <configuration-options>` or set the
9494
:parameter:`logComponentVerbosity` parameter using the
9595
:dbcommand:`setParameter` command or use the :method:`db.setLogLevel()`
9696
method. For examples, see :ref:`log-messages-configure-verbosity`.

source/reference/mongodb-extended-json.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _mongodb-extended-json-v2:
2+
13
==========================
24
MongoDB Extended JSON (v2)
35
==========================

source/reference/operator/update-field.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
.. _field-update-operators:
2+
3+
14
======================
25
Field Update Operators
36
======================

source/reference/program/mongod.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -672,7 +672,7 @@ Core Options
672672
The :option:`--shutdown` option cleanly and safely terminates the :program:`mongod`
673673
process. When invoking :program:`mongod` with this option you must set the
674674
:option:`--dbpath` option either directly or by way of the
675-
:doc:`configuration file </reference/configuration-options>` and the
675+
:ref:`configuration file <configuration-options>` and the
676676
:option:`--config` option.
677677

678678
The :option:`--shutdown` option is available only on Linux systems.
@@ -1388,7 +1388,7 @@ Storage Options
13881388
The directory where the :program:`mongod` instance stores its data.
13891389

13901390
If using the default
1391-
:doc:`configuration file </reference/configuration-options>`
1391+
:ref:`Configuration File <configuration-options>`
13921392
included with a package manager installation of MongoDB, the
13931393
corresponding :setting:`storage.dbPath` setting uses a different
13941394
default.

source/release-notes/2.6-compatibility.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -933,7 +933,7 @@ outputs. This format follows the template
933933
``YYYY-MM-DDTHH:mm:ss.mmm<+/-Offset>``. For example, ``2014-03-04T20:13:38.944-0500``.
934934

935935
This change impacts all clients using
936-
:doc:`Extended JSON </reference/mongodb-extended-json>` in *Strict mode*, such as
936+
:ref:`Extended JSON <mongodb-extended-json-v2>` in *Strict mode*, such as
937937
:binary:`~bin.mongoexport`.
938938

939939
.. _2.6-compatibility-other-resources:

source/release-notes/2.6.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -509,7 +509,7 @@ Configuration Options YAML File Format
509509

510510
MongoDB 2.6 supports a YAML-based configuration file format in addition
511511
to the previous configuration file format. See the documentation of
512-
the :doc:`Configuration File </reference/configuration-options>` for
512+
the :ref:`Configuration File <configuration-options>` for
513513
more information.
514514

515515
Operational Changes

source/release-notes/3.2-compatibility.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ storage engine setting either:
3838

3939
mongod --storageEngine mmapv1
4040

41-
- Or in a :doc:`configuration file </reference/configuration-options>`,
41+
- Or in a :ref:`configuration file <configuration-options>`,
4242
using the :setting:`storage.engine` setting:
4343

4444
.. code-block:: yaml

source/release-notes/3.2.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -464,7 +464,7 @@ engine setting either:
464464

465465
mongod --storageEngine mmapv1
466466

467-
- Or in a :doc:`configuration file </reference/configuration-options>`,
467+
- Or in a :ref:`Configuration File <configuration-options>`,
468468
using the :setting:`storage.engine` setting:
469469

470470
.. code-block:: yaml

source/release-notes/4.4.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2449,21 +2449,21 @@ Improvements to ``explain`` Results
24492449

24502450
Starting in version 4.4:
24512451

2452-
- :doc:`Explain results </reference/explain-results/>` for commands run
2452+
- :ref:`Explain results <explain-results>` for commands run
24532453
on sharded clusters include a top-level :ref:`serverInfo <serverInfo>`
24542454
object for the :binary:`~bin.mongos` in addition to the ``serverInfo``
24552455
objects returned for each shard. This is also available in versions
24562456
4.2.2, 4.0.14, and 3.6.16.
24572457

2458-
- :doc:`Explain results </reference/explain-results/>` include the
2458+
- :ref:`Explain results <explain-results>` include the
24592459
:ref:`serverInfo <serverInfo>` object when
24602460
:data:`~explain.queryPlanner.optimizedPipeline` is ``true``. In
24612461
previous versions of MongoDB, ``explain`` results would occasionally
24622462
not include the ``serverInfo`` object when
24632463
:data:`~explain.queryPlanner.optimizedPipeline` was ``true``. This is
24642464
also available in versions 4.2.2, 4.0.14, and 3.6.16.
24652465

2466-
- :doc:`Explain results </reference/explain-results/>` for aggregation include
2466+
- :ref:`Explain results <explain-results>` for aggregation include
24672467
the :data:`nReturned <explain.executionStats.nReturned>` and
24682468
:data:`executionTimeMillisEstimate
24692469
<explain.executionStats.executionStages.executionTimeMillisEstimate>` fields
@@ -2473,7 +2473,7 @@ Starting in version 4.4:
24732473

24742474
.. seealso::
24752475

2476-
:doc:`Explain results </reference/explain-results/>`.
2476+
:ref:`Explain results <explain-results>`.
24772477

24782478
``comment`` Option Available to all Database Commands
24792479
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

source/sharding.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ A MongoDB :term:`sharded cluster` consists of the following components:
8080
the sharded cluster. Starting in MongoDB 4.4, ``mongos`` can support
8181
:ref:`hedged reads <mongos-hedged-reads>` to minimize latencies.
8282

83-
* :doc:`config servers </core/sharded-cluster-config-servers>`: Config
83+
* :ref:`config servers <sharding-config-server>`: Config
8484
servers store metadata and configuration settings for the cluster.
8585

8686
The following graphic describes the interaction of components within a

source/tutorial/geospatial-tutorial.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ figure:
109109
.. include:: /images/geospatial-single-point.rst
110110

111111
Because the tutorial uses a ``2dsphere`` index, the geometry data in the
112-
``location`` field must follow the :doc:`GeoJSON format </reference/geojson>`.
112+
``location`` field must follow the :ref:`GeoJSON format <geospatial-indexes-store-geojson>`.
113113

114114
Now inspect an entry in the ``neighborhoods`` collection:
115115

source/tutorial/getting-started.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ examples in the shell above.
7979

8080
The following example uses the
8181
:method:`db.collection.insertMany()` method to insert new
82-
:doc:`documents </core/document>` into the ``movies``
82+
:ref:`documents <bson-document-format>` into the ``movies``
8383
collection. You can copy and paste the example into the
8484
:ref:`shell <mongo-web-shell>` above.
8585

source/tutorial/restart-sharded-cluster.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This procedure demonstrates the shutdown and startup sequence for restarting
1818
a sharded cluster. Stopping or starting the components of a sharded cluster
1919
in a different order may cause communication errors between members. For
2020
example, :doc:`shard </core/sharded-cluster-shards>` servers may appear to hang
21-
if there are no :doc:`config servers </core/sharded-cluster-config-servers>`
21+
if there are no :ref:`config servers <sharding-config-server>`
2222
available.
2323

2424
.. important:: This procedure should only be performed during a planned

0 commit comments

Comments
 (0)