Skip to content

Commit 5972183

Browse files
authored
1 parent 7fd2443 commit 5972183

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+119
-122
lines changed

source/administration/install-community.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@ These documents provide instructions to install MongoDB Community Edition.
1818

1919
.. _`MongoDB Download Center`: https://www.mongodb.com/try/download/community?tck=docs_server
2020

21-
:doc:`Install on Linux </administration/install-on-linux>`
21+
:ref:`Install on Linux <install-mdb-community-edition-linux>`
2222
Install MongoDB Community Edition and required dependencies on
2323
Linux.
2424

25-
:doc:`Install on macOS </tutorial/install-mongodb-on-os-x>`
25+
:ref:`Install on macOS <install-mdb-community-macos>`
2626
Install MongoDB Community Edition on macOS systems from MongoDB
2727
archives.
2828

29-
:doc:`Install on Windows </tutorial/install-mongodb-on-windows>`
29+
:ref:`Install on Windows <install-mdb-community-windows>`
3030
Install MongoDB Community Edition on Windows systems and
3131
optionally start MongoDB as a Windows service.
3232

source/administration/install-enterprise-linux.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,23 @@ Install MongoDB Enterprise on Linux
99
These documents provide instructions to install MongoDB Enterprise
1010
Edition for supported Linux systems.
1111

12-
:doc:`Install on Red Hat </tutorial/install-mongodb-enterprise-on-red-hat>`
12+
:ref:`Install on Red Hat <install-mdb-enterprise-redhat-centos>`
1313
Install MongoDB Enterprise and required dependencies on Red Hat
1414
Enterprise or CentOS Systems using packages.
1515

16-
:doc:`Install on Ubuntu </tutorial/install-mongodb-enterprise-on-ubuntu>`
16+
:ref:`Install on Ubuntu <install-mdb-enterprise-ubuntu>`
1717
Install MongoDB Enterprise and required dependencies on Ubuntu
1818
Linux Systems using packages.
1919

20-
:doc:`Install on Debian </tutorial/install-mongodb-enterprise-on-debian>`
20+
:ref:`Install on Debian <install-mdb-enterprise-debian>`
2121
Install MongoDB Enterprise and required dependencies on Debian
2222
Linux Systems using packages.
2323

24-
:doc:`Install on SUSE </tutorial/install-mongodb-enterprise-on-suse>`
24+
:ref:`Install on SUSE <install-mdb-enterprise-suse>`
2525
Install MongoDB Enterprise and required dependencies on SUSE
2626
Enterprise Linux.
2727

28-
:doc:`Install on Amazon </tutorial/install-mongodb-enterprise-on-amazon>`
28+
:ref:`Install on Amazon <install-mdb-enterprise-amazon-linux>`
2929
Install MongoDB Enterprise and required dependencies on Amazon
3030
Linux AMI.
3131

source/administration/install-enterprise.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,18 @@ Event Auditing.
2323

2424
.. include:: /includes/fact-macos-snmp.rst
2525

26-
:doc:`Install on Linux </administration/install-enterprise-linux>`
26+
:ref:`Install on Linux <install-enterprise-linux>`
2727
Install the official builds of MongoDB Enterprise on Linux-based
2828
systems.
2929

30-
:doc:`Install on macOS </tutorial/install-mongodb-enterprise-on-os-x>`
30+
:ref:`Install on macOS <install-enterprise-macos>`
3131
Install the official build of MongoDB Enterprise on macOS
3232

33-
:doc:`Install on Windows </tutorial/install-mongodb-enterprise-on-windows>`
33+
:ref:`Install on Windows <install-enterprise-windows>`
3434
Install MongoDB Enterprise on Windows using the ``.msi``
3535
installer.
3636

37-
:doc:`Install with Docker </tutorial/install-mongodb-enterprise-with-docker>`
37+
:ref:`Install with Docker <install-mdb-enterprise-docker>`
3838
Install a MongoDB Enterprise Docker container.
3939

4040

source/administration/install-on-linux.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,23 @@ Linux distributions. These packages are the preferred way to run
2121
MongoDB. The following guides detail the installation process for these
2222
systems:
2323

24-
:doc:`Install on Red Hat </tutorial/install-mongodb-on-red-hat>`
24+
:ref:`Install on Red Hat <install-mdb-community-redhat-centos>`
2525
Install MongoDB Community Edition on Red Hat Enterprise and
2626
related Linux systems using ``.rpm`` packages.
2727

28-
:doc:`Install on Ubuntu </tutorial/install-mongodb-on-ubuntu>`
28+
:ref:`Install on Ubuntu <install-mdb-community-ubuntu>`
2929
Install MongoDB Community Edition on Ubuntu Linux systems using
3030
``.deb`` packages.
3131

32-
:doc:`Install on Debian </tutorial/install-mongodb-on-debian>`
32+
:ref:`Install on Debian <install-mdb-community-debian>`
3333
Install MongoDB Community Edition on Debian systems using ``.deb``
3434
packages.
3535

36-
:doc:`Install on SUSE </tutorial/install-mongodb-on-suse>`
36+
:ref:`Install on SUSE <install-mdb-community-debian>`
3737
Install MongoDB Community Edition on SUSE Linux systems using
3838
``.rpm`` packages.
3939

40-
:doc:`Install on Amazon </tutorial/install-mongodb-on-amazon>`
40+
:ref:`Install on Amazon <install-mdb-community-amazon-linux>`
4141
Install MongoDB Community Edition on Amazon Linux AMI systems
4242
using ``.rpm`` packages.
4343

source/applications/indexes.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _indexing-strategies:
2+
13
===================
24
Indexing Strategies
35
===================

source/core/document.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Field Value Limit
9494
~~~~~~~~~~~~~~~~~
9595

9696
MongoDB 2.6 through MongoDB versions with :ref:`featureCompatibilityVersion <view-fcv>` (fCV) set to ``"4.0"`` or earlier
97-
For :doc:`indexed collections </indexes>`, the values for the
97+
For :ref:`indexed collections <indexes>`, the values for the
9898
indexed fields have a :limit:`Maximum Index Key Length <Index Key Limit>`. See
9999
:limit:`Maximum Index Key Length <Index Key Limit>` for details.
100100

source/core/index-case-insensitive.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Behavior
4545

4646
Using a case insensitive index does not affect
4747
the results of a query, but it can increase performance; see
48-
:doc:`Indexes</indexes>` for a detailed discussion of the costs and
48+
:ref:`Indexes <indexes>` for a detailed discussion of the costs and
4949
benefits of indexes.
5050

5151
To use an index that specifies a collation, query and sort operations

source/faq/indexes.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ FAQ: Indexes
1313
:class: singlecol
1414

1515
This document addresses some common questions regarding MongoDB
16-
:doc:`indexes </indexes>`. For more information on indexes, see
17-
:doc:`/indexes`.
16+
indexes. For more information on indexes, see
17+
:ref:`indexes <indexes>`.
1818

1919
How do I create an index?
2020
-------------------------
@@ -46,7 +46,7 @@ Index builds on replica sets have specific performance considerations
4646
and risks. See :ref:`index-operations-replicated-build` for more
4747
information. To minimize the impact of building an index on replica
4848
sets, including shard replica sets, use a rolling index build procedure
49-
as described in :doc:`/tutorial/build-indexes-on-replica-sets`.
49+
as described in :ref:`index-build-on-replica-sets`.
5050

5151
To return information on currently running index creation operations,
5252
see :ref:`currentOp-index-creation`. To kill a running index creation
@@ -77,10 +77,10 @@ How do I determine which fields to index?
7777

7878
A number of factors determine which fields to index, including
7979
:ref:`selectivity <index-selectivity>`, the support for multiple
80-
:term:`query shapes <query shape>`, and :doc:`size of the index
81-
</tutorial/ensure-indexes-fit-ram>`. For more information, see
80+
:term:`query shapes <query shape>`, and :ref:`size of the index
81+
<indexes-ensure-indexes-fit-ram>`. For more information, see
8282
:ref:`Operational Considerations for Indexes <data-model-indexes>` and
83-
:doc:`/applications/indexes`.
83+
:ref:`indexing-strategies`.
8484

8585
How can I see the size of an index?
8686
-----------------------------------

source/includes/4.2-upgrade-replacements.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@
99
.. |features| replace:: :ref:`features<4.2-compatibility-enabled>`
1010
.. |downgradeversion| replace:: 4.0
1111

12-
.. |installationdoc| replace:: :doc:`4.2 installation instructions </installation>`
12+
.. |installationdoc| replace:: :ref:`4.2 installation instructions <tutorial-installation>`
1313

source/includes/4.4-upgrade-replacements.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
.. |features| replace:: :ref:`features<4.4-compatibility-enabled>`
1111
.. |downgradeversion| replace:: 4.2
1212

13-
.. |installationdoc| replace:: :doc:`4.4 installation instructions </installation>`
13+
.. |installationdoc| replace:: :ref:`4.4 installation instructions <tutorial-installation>`
1414

1515
.. |newfcv| replace:: ``"4.4"``
16-
.. |oldfcv| replace:: ``"4.2"``
16+
.. |oldfcv| replace:: ``"4.2"``

source/includes/5.0-upgrade-replacements.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
.. |features| replace:: :ref:`features<5.0-compatibility-enabled>`
1111
.. |downgradeversion| replace:: 4.4
1212

13-
.. |installationdoc| replace:: :doc:`5.0 installation instructions </installation>`
13+
.. |installationdoc| replace:: :ref:`5.0 installation instructions <tutorial-installation>`
1414

1515
.. |newfcv| replace:: ``"5.0"``
16-
.. |oldfcv| replace:: ``"4.4"``
16+
.. |oldfcv| replace:: ``"4.4"``

source/includes/6.0-upgrade-replacements.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
.. |features| replace:: :ref:`features<6.0-downgrade-considerations>`
1111
.. |downgradeversion| replace:: 5.0
1212

13-
.. |installationdoc| replace:: :doc:`6.0 installation instructions </installation>`
13+
.. |installationdoc| replace:: :ref:`6.0 installation instructions <tutorial-installation>`
1414

1515
.. |newfcv| replace:: ``"6.0"``
1616
.. |oldfcv| replace:: ``"5.0"``

source/includes/extracts-enterprise.yaml

Lines changed: 10 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,11 @@ content: |
4040
manager, follow the package manager instructions for your
4141
operating system:
4242
43-
- :doc:`Red Hat Enterprise or CentOS </tutorial/install-mongodb-enterprise-on-red-hat>`
44-
45-
- :doc:`Ubuntu </tutorial/install-mongodb-enterprise-on-ubuntu>`
46-
47-
- :doc:`Debian </tutorial/install-mongodb-enterprise-on-debian>`
48-
49-
- :doc:`SUSE </tutorial/install-mongodb-enterprise-on-suse>`
50-
51-
- :doc:`Amazon Linux </tutorial/install-mongodb-enterprise-on-amazon>`
43+
- :ref:`Red Hat Enterprise or CentOS <install-mdb-enterprise-redhat-centos>`
44+
- :ref:`Ubuntu <install-mdb-enterprise-ubuntu>`
45+
- :ref:`Debian <install-mdb-enterprise-debian>`
46+
- :ref:`SUSE <install-mdb-enterprise-suse>`
47+
- :ref:`Amazon Linux <install-mdb-enterprise-amazon>`
5248
5349
During the installation, the package manager will remove the
5450
community packages; this will not affect the running
@@ -74,15 +70,11 @@ content: |
7470
directory and, if applicable, the existing configuration
7571
file.
7672
77-
- :doc:`Red Hat Enterprise or CentOS </tutorial/install-mongodb-enterprise-on-red-hat-tarball>`
78-
79-
- :doc:`Ubuntu </tutorial/install-mongodb-enterprise-on-ubuntu-tarball>`
80-
81-
- :doc:`Debian </tutorial/install-mongodb-enterprise-on-debian-tarball>`
82-
83-
- :doc:`SUSE </tutorial/install-mongodb-enterprise-on-suse-tarball>`
84-
85-
- :doc:`Amazon Linux </tutorial/install-mongodb-enterprise-on-amazon-tarball>`
73+
- :ref:`Red Hat Enterprise or CentOS <install-mdb-enterprise-redhat-centos-tgz>`
74+
- :ref:`Ubuntu <install-mdb-enterprise-ubuntu-tgz>`
75+
- :ref:`Debian <install-mdb-enterprise-debian-tgz>`
76+
- :ref:`SUSE <install-mdb-enterprise-suse-tgz>`
77+
- :ref:`Amazon Linux <install-mdb-enterprise-amazon-tgz>`
8678
8779
- id: windows
8880
name: Windows

source/includes/fact-check-amazon-linux-community.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ following command on the command-line:
77
88
The result should be **Amazon Linux** or **Amazon Linux AMI**. If using
99
a different Linux distribution, please see the
10-
:doc:`install instructions for your platform
11-
</administration/install-on-linux>`.
10+
:ref:`install instructions for your platform
11+
<install-mdb-community-edition-linux>`.

source/includes/fact-check-amazon-linux-enterprise.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ following command on the command-line:
77
88
The result should be **Amazon Linux** or **Amazon Linux AMI**. If using
99
a different Linux distribution, please see the
10-
:doc:`install instructions for your platform
11-
</administration/install-enterprise-linux>`.
10+
:ref:`install instructions for your platform
11+
<install-enterprise-linux>`.

source/includes/fact-default-conf-file.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
- If you :doc:`installed MongoDB </installation>` with a package manager
1+
- If you :ref:`installed MongoDB <tutorial-installation>` with a package manager
22
such as ``yum`` or ``apt`` on Linux or ``brew`` on macOS, or with the
33
MSI installer on Windows, a default :doc:`configuration file
44
</reference/configuration-options>` has been provided as part of your
@@ -27,7 +27,7 @@
2727
- MSI Installer
2828
- ``<install directory>\bin\mongod.cfg``
2929

30-
- If you :doc:`installed MongoDB </installation>` via a downloaded
30+
- If you :ref:`installed MongoDB <tutorial-installation>` via a downloaded
3131
``TGZ`` or ``ZIP`` file, you will need to create your own configuration
3232
file. The :ref:`basic example configuration <base-config>` is a good
3333
place to start.

source/includes/fact-download-dbtools-extra-server.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@ To install |tool-binary| as part of a MongoDB Enterprise Server
22
installation:
33

44
- Follow the instructions for your platform:
5-
:doc:`Install MongoDB Enterprise Server
6-
</administration/install-enterprise>`
5+
:ref:`Install MongoDB Enterprise Server <install-mdb-enterprise>`
76

87
- After completing the installation, |tool-binary| and the other
98
included tools are available in the same location as the Server.
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Starting in version 2.6, MongoDB can use :doc:`index
2-
intersection </core/index-intersection>` to fulfill queries. The choice
3-
between creating compound indexes that support your queries or relying
4-
on index intersection depends on the specifics of your system. See
1+
MongoDB can use :ref:`index intersection <index-intersection>` to
2+
fulfill queries. The choice between creating compound indexes that
3+
support your queries or relying on index intersection depends on the
4+
specifics of your system. See
55
:ref:`index-intersection-compound-indexes` for more details.

source/includes/steps-convert-replica-set-enable-sharding.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ title:
3030
stepnum: 3
3131
ref: enable-sharding-create-index
3232
pre: |
33-
Before sharding a non-empty collection, create an :doc:`index on
34-
the shard key </core/sharding-shard-key>`.
33+
Before sharding a non-empty collection, create an :ref:`index on
34+
the shard key <sharding-shard-key>`.
3535
action:
3636
language: sh
3737
code: |

source/reference/command/delete.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,8 +170,8 @@ Each element of the ``deletes`` array contains the following fields:
170170
- Document or string
171171
- .. _deletes-array-hint:
172172

173-
Optional. A document or string that specifies the :doc:`index
174-
</indexes>` to use to support the :ref:`query predicate
173+
Optional. A document or string that specifies the :ref:`index
174+
<indexes>` to use to support the :ref:`query predicate
175175
<deletes-array-q>`.
176176

177177
The option can take an index specification document or the

source/reference/command/findAndModify.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ The command takes the following fields:
191191
* - ``hint``
192192
- document or string
193193
- Optional. A document or string that specifies the
194-
:doc:`index </indexes>` to use to support the ``query``.
194+
:ref:`index <indexes>` to use to support the ``query``.
195195

196196
The option can take an index specification document or the
197197
index name string.

source/reference/command/update.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -221,8 +221,8 @@ Each document contains the following fields:
221221

222222
- .. _update-command-hint:
223223

224-
Optional. A document or string that specifies the :doc:`index
225-
</indexes>` to use to support the :ref:`query predicate
224+
Optional. A document or string that specifies the :ref:`index
225+
<indexes>` to use to support the :ref:`query predicate
226226
<update-command-q>`.
227227

228228
The option can take an index specification document or the index

source/reference/configuration-options.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -920,15 +920,15 @@ Core Options
920920
directory, or a systemd unit file registered with ``systemctl``. Only
921921
use the :setting:`processManagement.pidFilePath` option if you are not using one of these init
922922
systems. For more information, please see the respective
923-
:doc:`Installation Guide </installation>` for your operating system.
923+
:ref:`Installation Guide <tutorial-installation>` for your operating system.
924924

925925
.. note:: macOS
926926

927927

928928
On macOS, PID file management is generally handled by ``brew``. Only use
929929
the :setting:`processManagement.pidFilePath` option if you are not using ``brew`` on your macOS system.
930930
For more information, please see the respective
931-
:doc:`Installation Guide </installation>` for your operating system.
931+
Installation Guide for your operating system.
932932

933933
.. setting:: processManagement.timeZoneInfo
934934

source/reference/database-profiler.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,7 @@ operation.
295295
.. versionchanged:: 3.2.0
296296

297297
Renamed from ``system.profile.nscanned``.
298-
The number of :doc:`index </indexes>` keys that MongoDB scanned in
298+
The number of :ref:`index <indexes>` keys that MongoDB scanned in
299299
order to carry out the operation.
300300

301301
In general, if :data:`~system.profile.keysExamined` is much higher
@@ -415,7 +415,7 @@ operation.
415415

416416
*Removed in 3.4.*
417417

418-
The number of :doc:`index </indexes>` keys the update changed in
418+
The number of index keys the update changed in
419419
the operation. Changing an index key carries a small performance
420420
cost because the database must remove the old key and inserts a new
421421
key into the B-tree index.

source/reference/explain-results.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -914,7 +914,7 @@ is ``0``.
914914
Index Intersection
915915
------------------
916916

917-
For an :doc:`index intersection plan </core/index-intersection>`, the
917+
For an :ref:`index intersection plan <index-intersection>`, the
918918
result will include either an ``AND_SORTED`` stage or an ``AND_HASH``
919919
stage with an :data:`explain.queryPlanner.winningPlan.inputStages` array that
920920
details the indexes; e.g.:

source/reference/glossary.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -486,7 +486,7 @@ Glossary
486486
process. If you installed MongoDB via a package manager, an init
487487
script has been provided for your system as part of the
488488
installation. See the respective
489-
:doc:`Installation Guide </installation>` for your operating
489+
:ref:`Installation Guide <tutorial-installation>` for your operating
490490
system.
491491

492492
init system
@@ -498,7 +498,7 @@ Glossary
498498
Linux tend to use the **systemd** init system, which uses the
499499
``systemctl`` command, while older versions tend to use the
500500
**System V** init system, which uses the ``service`` command.
501-
See the respective :doc:`Installation Guide </installation>` for
501+
See the respective Installation Guide for
502502
your operating system.
503503

504504
initial sync

0 commit comments

Comments
 (0)