Skip to content

Commit 9c258a2

Browse files
authored
(DOCSP-26418): Replace remaining 2d inline doc directives (#2213)
* replace doc directives * fix build errors * small fixes * tech review feedback
1 parent 74cbe47 commit 9c258a2

21 files changed

+56
-58
lines changed

source/core/geohaystack.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ results over small areas. ``geoHaystack`` indexes improve performance
2121
on queries that use flat geometry.
2222

2323
For queries that use spherical geometry, a **2dsphere index is a better
24-
option** than a haystack index. :doc:`2dsphere indexes
25-
</core/2dsphere>` allow field reordering; ``geoHaystack`` indexes
24+
option** than a haystack index. :ref:`2dsphere indexes
25+
<2dsphere-index>` allow field reordering; ``geoHaystack`` indexes
2626
require the first field to be the location field. Also, ``geoHaystack``
2727
indexes are only usable via commands and so always return all results
2828
at once.

source/core/index-creation.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,7 @@ process:
413413
indexed fields. For example, a document with duplicate field
414414
values when building a :ref:`unique index <index-type-unique>`
415415
*or* malformed :ref:`GeoJSON objects <geospatial-geojson>` when
416-
building a :doc:`2dsphere index </core/2dsphere>`.
416+
building a :ref:`2dsphere index <2dsphere-index>`.
417417

418418
* - Lock
419419

source/includes/extracts-4.4-changes.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,7 @@ content: |
331331
ref: 4.4-changes-geo-deprecation
332332
content: |
333333
MongoDB 4.4 deprecates the :doc:`geoHaystack </core/geohaystack>` index and the
334-
:dbcommand:`geoSearch` command. Use a :doc:`2d index </core/2d>`
334+
:dbcommand:`geoSearch` command. Use a :ref:`2d index <2d-index>`
335335
with :pipeline:`$geoNear` or :query:`$geoWithin` instead.
336336
---
337337
ref: 4.4-changes-index-builds-simultaneous-fcv

source/includes/extracts-geonear-facts.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,6 @@ content: |
2121
---
2222
ref: geoNear-stage-index-requirement
2323
content: |
24-
:pipeline:`$geoNear` requires a :doc:`geospatial index
25-
</core/geospatial-indexes>`.
24+
:pipeline:`$geoNear` requires a :ref:`geospatial index
25+
<index-feature-geospatial>`.
2626
...

source/includes/fact-5.0-geohaystack-removed.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MongoDB 5.0 removes the deprecated :doc:`geoHaystack
22
</core/geohaystack>` index and :dbcommand:`geoSearch` command. Use a
3-
:doc:`2d index </core/2d>` with :pipeline:`$geoNear` or one of the
3+
:ref:`2d index <2d-index>` with :pipeline:`$geoNear` or one of the
44
supported :ref:`geospatial query operators <geospatial-query-selectors>`
55
instead.
66

source/indexes.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -169,11 +169,11 @@ Geospatial Index
169169
~~~~~~~~~~~~~~~~
170170

171171
To support efficient queries of geospatial coordinate data, MongoDB
172-
provides two special indexes: :doc:`2d indexes </core/2d>` that uses
173-
planar geometry when returning results and :doc:`2dsphere indexes
174-
</core/2dsphere>` that use spherical geometry to return results.
172+
provides two special indexes: :ref:`2d indexes <2d-index>` that uses
173+
planar geometry when returning results and :ref:`2dsphere indexes
174+
<2dsphere-index>` that use spherical geometry to return results.
175175

176-
See :doc:`/core/geospatial-indexes` for a high level introduction to
176+
See :ref:`index-feature-geospatial` for a high level introduction to
177177
geospatial indexes.
178178

179179
Text Indexes

source/reference/limits.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -422,7 +422,7 @@ Operations
422422

423423
- :query:`$or`
424424

425-
- :doc:`/core/geospatial-indexes`
425+
- :ref:`2d-index-internals`
426426

427427
.. limit:: Geospatial Queries
428428

source/reference/operator/aggregation/geoNear.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -426,8 +426,8 @@ The aggregation returns a document with:
426426
Specify Which Geospatial Index to Use
427427
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
428428

429-
Consider a ``places`` collection that has a :doc:`2dsphere
430-
</core/2dsphere>` index on the ``location`` field and a
429+
Consider a ``places`` collection that has a :ref:`2dsphere
430+
<2dsphere-index>` index on the ``location`` field and a
431431
:ref:`2d <2d-index>` index on the ``legacy`` field.
432432

433433
A document in the ``places`` collection resembles the following:

source/reference/operator/query-geospatial.txt

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -41,25 +41,23 @@ Query Selectors
4141
* - :query:`$geoWithin`
4242

4343
- Selects geometries within a bounding :ref:`GeoJSON geometry
44-
<geospatial-indexes-store-geojson>`. The :doc:`2dsphere
45-
</core/2dsphere>` and :ref:`2d <2d-index>` indexes support
44+
<geospatial-indexes-store-geojson>`. The :ref:`2dsphere
45+
<2dsphere-index>` and :ref:`2d <2d-index>` indexes support
4646
:query:`$geoWithin`.
4747

4848

4949
* - :query:`$near`
5050

5151
- Returns geospatial objects in proximity to a point.
52-
Requires a geospatial index. The :doc:`2dsphere
53-
</core/2dsphere>` and :ref:`2d <2d-index>` indexes support
54-
:query:`$near`.
52+
Requires a geospatial index. The ``2dsphere``
53+
and ``2d`` indexes support :query:`$near`.
5554

5655

5756
* - :query:`$nearSphere`
5857

5958
- Returns geospatial objects in proximity to a point on a sphere.
60-
Requires a geospatial index. The :doc:`2dsphere
61-
</core/2dsphere>` and :ref:`2d <2d-index>` indexes support
62-
:query:`$nearSphere`.
59+
Requires a geospatial index. The ``2dsphere``
60+
and ``2d`` indexes support :query:`$nearSphere`.
6361

6462

6563

@@ -86,15 +84,15 @@ Geometry Specifiers
8684
* - :query:`$box`
8785

8886
- Specifies a rectangular box using legacy coordinate pairs for
89-
:query:`$geoWithin` queries. The :ref:`2d <2d-index>` index supports
90-
:query:`$box`.
87+
:query:`$geoWithin` queries. The :ref:`2d <2d-index>` index
88+
supports :query:`$box`.
9189

9290

9391
* - :query:`$center`
9492

9593
- Specifies a circle using legacy coordinate pairs to
96-
:query:`$geoWithin` queries when using planar geometry. The :doc:`2d
97-
</core/2d>` index supports :query:`$center`.
94+
:query:`$geoWithin` queries when using planar geometry. The
95+
``2d`` index supports :query:`$center`.
9896

9997

10098
* - :query:`$centerSphere`
@@ -112,9 +110,8 @@ Geometry Specifiers
112110
* - :query:`$maxDistance`
113111

114112
- Specifies a maximum distance to limit the results of :query:`$near`
115-
and :query:`$nearSphere` queries. The :doc:`2dsphere
116-
</core/2dsphere>` and :ref:`2d <2d-index>` indexes support
117-
:query:`$maxDistance`.
113+
and :query:`$nearSphere` queries. The ``2dsphere``
114+
and ``2d`` indexes support :query:`$maxDistance`.
118115

119116

120117
* - :query:`$minDistance`
@@ -127,7 +124,7 @@ Geometry Specifiers
127124
* - :query:`$polygon`
128125

129126
- Specifies a polygon to using legacy coordinate pairs for
130-
:query:`$geoWithin` queries. The :ref:`2d <2d-index>` index supports
127+
:query:`$geoWithin` queries. The ``2d`` index supports
131128
:query:`$center`.
132129

133130
.. toctree::

source/reference/operator/query.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -195,24 +195,24 @@ Geospatial
195195
* - :query:`$geoWithin`
196196

197197
- Selects geometries within a bounding :ref:`GeoJSON geometry
198-
<geospatial-indexes-store-geojson>`. The :doc:`2dsphere
199-
</core/2dsphere>` and :ref:`2d <2d-index>` indexes support
198+
<geospatial-indexes-store-geojson>`. The :ref:`2dsphere
199+
<2dsphere-index>` and :ref:`2d <2d-index>` indexes support
200200
:query:`$geoWithin`.
201201

202202

203203
* - :query:`$near`
204204

205205
- Returns geospatial objects in proximity to a point.
206-
Requires a geospatial index. The :doc:`2dsphere
207-
</core/2dsphere>` and :ref:`2d <2d-index>` indexes support
206+
Requires a geospatial index. The :ref:`2dsphere
207+
<2dsphere-index>` and :ref:`2d <2d-index>` indexes support
208208
:query:`$near`.
209209

210210

211211
* - :query:`$nearSphere`
212212

213213
- Returns geospatial objects in proximity to a point on a sphere.
214-
Requires a geospatial index. The :doc:`2dsphere
215-
</core/2dsphere>` and :ref:`2d <2d-index>` indexes support
214+
Requires a geospatial index. The :ref:`2dsphere
215+
<2dsphere-index>` and :ref:`2d <2d-index>` indexes support
216216
:query:`$nearSphere`.
217217

218218

source/reference/operator/query/geoWithin.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,8 @@ Geospatial Indexes
104104
~~~~~~~~~~~~~~~~~~
105105

106106
:query:`$geoWithin` does not require a geospatial index. However, a
107-
geospatial index will improve query performance. Both :doc:`2dsphere
108-
</core/2dsphere>` and :ref:`2d <2d-index>` geospatial indexes support
107+
geospatial index will improve query performance. Both :ref:`2dsphere
108+
<2dsphere-index>` and :ref:`2d <2d-index>` geospatial indexes support
109109
:query:`$geoWithin`.
110110

111111
Unsorted Results

source/reference/operator/query/near.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Definition
2222
:query:`$near` requires a geospatial index:
2323

2424
- :ref:`2dsphere <2dsphere-index>` index if specifying a
25-
:term:`GeoJSON` point,
25+
:term:`GeoJSON` point.
2626

2727
- :ref:`2d <2d-index>` index if specifying a point using legacy
2828
coordinates.

source/reference/operator/query/nearSphere.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ Definition
2222
:query:`$nearSphere` *requires* a geospatial index:
2323

2424
- :ref:`2dsphere <2dsphere-index>` index for location data defined
25-
as GeoJSON points
25+
as GeoJSON points.
2626

2727
- :ref:`2d <2d-index>` index for location data defined as legacy
28-
coordinate pairs. To use a :ref:`2d <2d-index>` index on
28+
coordinate pairs. To use a ``2d`` index on
2929
:ref:`GeoJSON points <geojson-point>`, create the index on the
3030
``coordinates`` field of the GeoJSON object.
3131

@@ -114,8 +114,8 @@ Specify Center Point Using Legacy Coordinates
114114
````````````
115115

116116
Consider a collection ``legacyPlaces`` that contains documents with
117-
legacy coordinates pairs in the ``location`` field and has a :doc:`2d
118-
</core/2d>` index.
117+
legacy coordinates pairs in the ``location`` field and has a :ref:`2d
118+
<2d-index>` index.
119119

120120
Then, the following example returns those documents whose ``location``
121121
is at most ``0.10`` radians from the specified point, ordered from

source/release-notes/1.2.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _release-notes-1.2:
2+
13
===============================
24
Release Notes for MongoDB 1.2.x
35
===============================

source/release-notes/1.4.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Upgrading
1616
We're pleased to announce the 1.4 release of MongoDB. 1.4 is a drop-in
1717
replacement for 1.2. To upgrade you just need to shutdown
1818
:binary:`~bin.mongod`, then restart with the new binaries. (Users upgrading
19-
from release 1.0 should review the :doc:`1.2 release notes </release-notes/1.2>`,
19+
from release 1.0 should review the :ref:`1.2 release notes <release-notes-1.2>`,
2020
in particular the instructions for upgrading the DB format.)
2121

2222
Release 1.4 includes the following improvements over release 1.2:

source/release-notes/2.4.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ Add support for text search of content in MongoDB databases as a
229229
Geospatial Support Enhancements
230230
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
231231

232-
- Add new :doc:`2dsphere index </core/2dsphere>`. The new index
232+
- Add new :ref:`2dsphere index <2dsphere-index>`. The new index
233233
supports `GeoJSON <https://tools.ietf.org/html/rfc7946>`_ objects
234234
``Point``, ``LineString``, and ``Polygon``. See
235235
:doc:`/core/2dsphere` and :doc:`/geospatial-queries`.

source/release-notes/2.6-compatibility.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -381,8 +381,8 @@ Solution
381381
----------------------------
382382

383383
Description
384-
MongoDB 2.6 introduces a version 2 of the :doc:`2dsphere index
385-
</core/2dsphere>`. If a document lacks a ``2dsphere``
384+
MongoDB 2.6 introduces a version 2 of the :ref:`2dsphere index
385+
<2dsphere-index>`. If a document lacks a ``2dsphere``
386386
index field (or the field is ``null`` or an empty array), MongoDB
387387
does not add an entry for the document to the ``2dsphere`` index.
388388
For inserts, MongoDB inserts the document but does not add to the

source/release-notes/3.2.txt

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1223,13 +1223,12 @@ The diagnostic logs and the system profiler report on this statistic.
12231223
Geospatial Optimization
12241224
~~~~~~~~~~~~~~~~~~~~~~~
12251225

1226-
MongoDB 3.2 introduces version 3 of :doc:`2dsphere
1227-
indexes </core/2dsphere>`, which index :doc:`GeoJSON geometries
1228-
</reference/geojson>` at a finer gradation. The new version improves
1229-
performance of :doc:`2dsphere index </core/2dsphere>` queries over
1230-
smaller regions. In addition, for both :doc:`2d indexes </core/2d>` and
1231-
:doc:`2dsphere indexes </core/2dsphere>`, the performance of
1232-
geoNear queries has been improved for dense datasets.
1226+
MongoDB 3.2 introduces version 3 of :ref:`2dsphere-index`, which index
1227+
:doc:`GeoJSON geometries </reference/geojson>` at a finer gradation. The
1228+
new version improves performance of ``2dsphere`` index queries over
1229+
smaller regions. In addition, for both :ref:`2d-index` and ``2dsphere``
1230+
indexes, the performance of geoNear queries has been improved for dense
1231+
datasets.
12331232

12341233
.. seealso::
12351234

source/release-notes/4.0.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1495,8 +1495,8 @@ Geospatial Query Improvements
14951495
- As of MongoDB 4.0, the :pipeline:`$geoNear` aggregation operator and
14961496
``geoNear`` command support using the ``minDistance`` option
14971497
with :ref:`2d <2d-index>` indexes. Similarly, :query:`$near` and
1498-
:query:`$nearSphere` support the ``$minDistance`` option for :doc:`2d
1499-
</core/2d>` indexes. Previously, ``minDistance`` and ``$minDistance``
1498+
:query:`$nearSphere` support the ``$minDistance`` option for :ref:`2d
1499+
<2d-index>` indexes. Previously, ``minDistance`` and ``$minDistance``
15001500
were only available for :ref:`2dsphere <2dsphere-index>` indexes.
15011501

15021502
- MongoDB 4.0 adds a ``key`` option for the :pipeline:`$geoNear`

source/release-notes/5.0-compatibility.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Removed Index Types
107107
-------------------
108108

109109
MongoDB 5.0 removes the deprecated :doc:`geoHaystack
110-
</core/geohaystack>` index. Use a :doc:`2d index </core/2d>` instead.
110+
</core/geohaystack>` index. Use a :ref:`2d index <2d-index>` instead.
111111

112112
Upgrading your MongoDB instance to 5.0 and setting
113113
:ref:`featureCompatibilityVersion <view-fcv>` to ``5.0`` will delete any

source/release-notes/6.0.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -774,7 +774,7 @@ Additional Secondary Index Types
774774

775775
You can add additional :term:`secondary index <secondary index>` types
776776
to time series collections, including :ref:`2dsphere <2dsphere-index>`
777-
and :doc:`2d </core/2d>` indexes.
777+
and :ref:`2d <2d-index>` indexes.
778778

779779
For all additional indexes and other improvements, see
780780
:ref:`timeseries-add-secondary-index-mongodb-6.0`.

0 commit comments

Comments
 (0)