Skip to content

Commit ed7c887

Browse files
Docsp 16488 broken links (#99)
1 parent 3db8fe9 commit ed7c887

24 files changed

+94
-96
lines changed

source/fundamentals/aggregation.txt

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ Using ``aggregation`` operations, you can:
4343
- summarize data
4444
- group values
4545

46-
Aggregation operations have some :manual:`limitations <core/aggregation-pipeline-limits/>` you must keep in mind:
46+
Aggregation operations have some :manual:`limitations </core/aggregation-pipeline-limits/>` you must keep in mind:
4747

48-
- Returned documents must not violate the :manual:`BSON document size limit </reference/limits/#BSON-Document-Size>`
48+
- Returned documents must not violate the :manual:`BSON document size limit </reference/limits/#mongodb-limit-BSON-Document-Size>`
4949
of 16 megabytes.
5050

5151
- Pipeline stages have a memory limit of 100 megabytes by default. If required, you may exceed this limit by using
@@ -54,7 +54,7 @@ Aggregation operations have some :manual:`limitations <core/aggregation-pipeline
5454

5555
.. important:: ``$graphLookup`` exception
5656

57-
The :manual:`$graphLookup </operator/aggregation/graphLookup/>` stage has a strict memory limit of 100 megabytes
57+
The :manual:`$graphLookup </reference/operator/aggregation/graphLookup/>` stage has a strict memory limit of 100 megabytes
5858
and will ignore ``allowDiskUse``.
5959

6060
Useful References
@@ -115,21 +115,23 @@ Insert the Data
115115
Basic Aggregation Example
116116
~~~~~~~~~~~~~~~~~~~~~~~~~
117117

118-
To perform an aggregation, pass a list of aggregation stages to the `MongoCollection.aggregate() <https://mongodb.github.io/mongo-java-driver/4.2/apidocs/mongodb-driver-core/com/mongodb/client/MongoCollection.html#aggregate(com.mongodb.client.ClientSession,java.util.List,java.lang.Class)>`__
118+
To perform an aggregation, pass a list of aggregation stages to the
119+
:java-docs:`MongoCollection.aggregate() <apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#aggregate(java.util.List)>`
119120
method.
120121

121-
The Java driver provides the `Aggregates <https://mongodb.github.io/mongo-java-driver/4.2/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html>`__
122+
The Java driver provides the
123+
:java-docs:`Aggregates <apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html>`
122124
helper class that
123125
contains builders for aggregation stages.
124126

125127
In the following example, the aggregation pipeline:
126128

127-
- Uses a :manual:`$match <reference/operator/aggregation/match/>` stage to filter for documents whose
129+
- Uses a :manual:`$match </reference/operator/aggregation/match/>` stage to filter for documents whose
128130
``categories`` array field contains the element ``Bakery``. The example uses
129-
`Aggregates.match <https://mongodb.github.io/mongo-java-driver/4.2/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#match(org.bson.conversions.Bson)>`__
131+
:java-docs:`Aggregates.match <apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#match(org.bson.conversions.Bson)>`
130132
to build the ``$match`` stage.
131133

132-
- Uses a :manual:`$group <reference/operator/aggregation/group/>` stage to group the matching documents by the ``stars``
134+
- Uses a :manual:`$group </reference/operator/aggregation/group/>` stage to group the matching documents by the ``stars``
133135
field, accumulating a count of documents for each distinct value of ``stars``.
134136

135137
.. note::
@@ -196,8 +198,10 @@ following resources:
196198
Aggregation Expression Example
197199
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
198200

199-
The Java driver provides builders for :java-sync-api:`accumulator expressions<com/mongodb/client/model/Accumulators.html>`
200-
for use with :java-sync-api:`$group <com/mongodb/client/model/Aggregates.html#group(TExpression,java.util.List)>`. You
201+
The Java driver provides builders for
202+
:java-docs:`accumulator expressions <apidocs/mongodb-driver-core/com/mongodb/client/model/Accumulators.html>`
203+
for use with
204+
:java-docs:`$group <apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#group(TExpression,java.util.List)>`. You
201205
must declare all other expressions in JSON format or compatible document format.
202206

203207
.. tip::

source/fundamentals/auth.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ mechanism:
273273

274274
To specify the ``MONGODB-AWS`` authentication mechanism using the
275275
``MongoCredential`` class, use the
276-
:java-docs:`createAwsCredential() </apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#createAwsCredential(java.lang.String,char%5B%5D)>`
276+
:java-docs:`createAwsCredential() <apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#createAwsCredential(java.lang.String,char%5B%5D)>`
277277
method. Your code to instantiate a ``MongoClient`` should look something like this:
278278

279279
.. include:: /includes/fundamentals/code-snippets/auth-credentials-aws.rst
@@ -358,7 +358,7 @@ mechanism:
358358
``MongoCredential`` class, use the
359359
:java-docs:`createMongoX509Credential() </apidocs/mongodb-driver-core/com/mongodb/MongoCredential.html#createMongoX509Credential(java.lang.String)>`
360360
method. Also, enable TLS by calling the
361-
:java-sync-api:`applyToSslSettings() <com/mongodb/MongoClientSettings.Builder.html#applyToSslSettings(com.mongodb.Block)>`
361+
:java-docs:`applyToSslSettings() <apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html#applyToSslSettings(com.mongodb.Block)>`
362362
method and setting the ``enabled`` property to ``true`` in the
363363
:java-docs:`SslSettings.Builder </apidocs/mongodb-driver-core/com/mongodb/connection/SslSettings.Builder.html>`
364364
block. Your code to instantiate a ``MongoClient`` should look something like this:

source/fundamentals/builders/filters.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -462,7 +462,7 @@ The geospatial operator methods include:
462462

463463
The following example creates a filter that matches documents in which
464464
the ``point`` field contains a GeoJSON geometry that falls within
465-
the given :manual:`Polygon </reference/geojson/index.html#polygon>`
465+
the given :manual:`Polygon </reference/geojson/#polygon>`
466466
in the ``geo_points`` collection:
467467

468468
.. literalinclude:: /includes/fundamentals/code-snippets/Filters.java

source/fundamentals/builders/projections.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ The following code shows the output from this projection:
249249

250250

251251
When you've specified matching criteria in the **query** portion of your operation, use the ``elemMatch(String)`` method
252-
variant to specify a :manual:`positional projection </reference/operator/projection/positional/#projection/>` to include
252+
variant to specify a :manual:`positional projection </reference/operator/projection/positional/#sorts-and-the-positional-operator>` to include
253253
the first element of an array. Only documents that match the query filter will be retrieved.
254254

255255
.. warning::
@@ -350,7 +350,7 @@ Project a Text Score
350350
~~~~~~~~~~~~~~~~~~~~
351351

352352
Use the ``metaTextScore()`` method to specify a projection of
353-
:manual:`score of a text query </reference/operator/query/text/#return-the-text-search-score/>`
353+
:manual:`score of a text query </reference/operator/query/text/#text-score>`
354354

355355
The following example projects the text score as the value of the ``score`` field:
356356

source/fundamentals/builders/updates.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ Current Date
283283
~~~~~~~~~~~~
284284
Use the :java-core-api:`currentDate() <com/mongodb/client/model/Updates.html#currentDate(java.lang.String)>`
285285
method to assign the value of a field in an update operation to the
286-
current date as a :manual:`date </reference/bson-types/#document-bson-type-date>`.
286+
current date as a :manual:`date </reference/bson-types/#date>`.
287287

288288
The following example sets the value of the ``lastModified`` field to
289289
the current date as a BSON date:
@@ -311,7 +311,7 @@ Current Timestamp
311311
~~~~~~~~~~~~~~~~~
312312
Use the :java-core-api:`currentTimestamp() <com/mongodb/client/model/Updates.html#currentTimestamp(java.lang.String)>`
313313
method to assign the value of a field in an update operation to the
314-
current date as a :manual:`timestamp </reference/bson-types/#document-bson-type-timestamp>`.
314+
current date as a :manual:`timestamp </reference/bson-types/#timestamps>`.
315315

316316
The following example sets the value of the ``lastModified`` field to
317317
the current date as a BSON timestamp:

source/fundamentals/connection.txt

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -57,17 +57,16 @@ connected. The following example shows each part of the connection URI:
5757
:alt: Connection String parts figure
5858

5959
In this example, for the protocol, we use ``mongodb+srv`` which specifies the
60-
:manual:`DNS Seedlist Connection Format
61-
</reference/connection-string/#dns-seedlist-connection-format>`. This indicates
62-
that the hostname following it corresponds to the DNS SRV record of your
60+
:manual:`DNS Seedlist Connection Format </reference/connection-string/#std-label-connections-dns-seedlist>`.
61+
This indicates that the hostname following it corresponds to the DNS SRV record of your
6362
MongoDB instance or deployment. If your instance or deployment does not have a
6463
DNS SRV record, use ``mongodb`` to specify the :manual:`Standard Connection
6564
Format </reference/connection-string/#standard-connection-string-format>`.
6665

6766
.. note::
6867

6968
If your deployment is on MongoDB Atlas, follow the
70-
:atlas:`Atlas driver connection guide <driver-connection?jmp=docs_driver_java>`
69+
:atlas:`Atlas driver connection guide </driver-connection?jmp=docs_driver_java>`
7170
to retrieve your connection string.
7271

7372
The next part of the connection string contains your username and password
@@ -132,9 +131,8 @@ replica set named "myRs".
132131

133132
.. note::
134133

135-
The :manual:`replicaSet option
136-
</reference/connection-string/#urioption.replicaSet>` is not
137-
necessary to connect to a replica set, since the driver automatically
134+
The :manual:`replicaSet option </reference/connection-string/#replica-set-option>`
135+
is not necessary to connect to a replica set, since the driver automatically
138136
detects and handles multiple hosts in the connection string as a
139137
replica set.
140138

@@ -199,11 +197,12 @@ using a method in the ``MongoClientSettings.Builder`` class.
199197
.. tab:: MongoClientSettings
200198
:tabid: mongoclientsettings
201199

202-
To enable compression with :java-sync-api:`MongoClientSettings
203-
<com/mongodb/MongoClientSettings.html>`, pass the
204-
:java-sync-api:`compressorList()
205-
<com/mongodb/MongoClientSettings.Builder.html#compressorList(java.util.List)>`
206-
builder method a list of :java-sync-api:`MongoCompressor <com/mongodb/MongoCompressor.html>`
200+
To enable compression with
201+
:java-docs:`MongoClientSettings <apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.html>`,
202+
pass the
203+
:java-docs:`compressorList() <apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html#compressorList(java.util.List)>`
204+
builder method a list of
205+
:java-docs:`MongoCompressor <apidocs/mongodb-driver-core/com/mongodb/MongoCompressor.html>`
207206
instances. You can specify one or more compression algorithms in the list:
208207

209208
.. code-block:: java
@@ -346,20 +345,19 @@ parameters of the connection URI to specify the behavior of the client.
346345
- integer
347346
- Specifies a time limit, in milliseconds, for the write concern. For
348347
more information, see the server documentation for the
349-
:manual:`wtimeoutMS option
350-
</reference/connection-string/#urioption.wtimeoutMS>`.
348+
:manual:`wtimeoutMS option </reference/connection-string/#write-concern-options>`.
351349

352350
* - **readPreference**
353351
- string
354352
- Specifies the read preference. For more information on values, see
355-
the server documentation for the :manual:`readPreference option
356-
</reference/connection-string/#urioption.readPreference>`.
353+
the server documentation for the
354+
:manual:`readPreference option </reference/connection-string/#urioption.readPreference>`.
357355

358356
* - **readPreferenceTags**
359357
- string
360358
- Specifies the read preference tags. For more information on values, see
361-
the server documentation for the :manual:`readPreferenceTags option
362-
</reference/connection-string/#urioption.readPreferenceTags>`.
359+
the server documentation for the
360+
:manual:`readPreferenceTags option </reference/connection-string/#urioption.readPreferenceTags>`.
363361

364362
* - **maxStalenessSeconds**
365363
- integer
@@ -369,8 +367,7 @@ parameters of the connection URI to specify the behavior of the client.
369367
should be no staleness check for secondaries. The minimum value is
370368
either 90 seconds or the heartbeat frequency plus 10 seconds, whichever
371369
is greater. For more information, see the server documentation for the
372-
:manual:`maxStalenessSeconds option
373-
</reference/connection-string/#urioption.maxStalenessSeconds>`.
370+
:manual:`maxStalenessSeconds option </reference/connection-string/#urioption.maxStalenessSeconds>`.
374371

375372
* - **authMechanism**
376373
- string
@@ -431,12 +428,13 @@ parameters of the connection URI to specify the behavior of the client.
431428
- string
432429
- Specifies the UUID representation to use for read and write
433430
operations. For more information, see the the driver documentation
434-
for the :java-sync-api:`MongoClientSettings.getUuidRepresentation() method
435-
<com/mongodb/MongoClientSettings.html#getUuidRepresentation()>`.
431+
for the
432+
:java-docs:`MongoClientSettings.getUuidRepresentation() method <apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.html#getUuidRepresentation()>`.
436433

437434
* - **directConnection**
438435
- boolean
439436
- Specifies that the driver must connect to the host directly.
440437

441-
For a complete list of options, see the :java-sync-api:`ConnectionString
442-
<com/mongodb/ConnectionString.html>` API reference page.
438+
For a complete list of options, see the
439+
:java-docs:`ConnectionString <apidocs/mongodb-driver-core/com/mongodb/ConnectionString.html>`
440+
API reference page.

source/fundamentals/connection/tls.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ using a method in the ``MongoClientSettings.Builder`` class.
5050
:tabid: mongoclientsettings
5151

5252
To configure your ``MongoClient``'s TLS/SSL connection options using the
53-
``MongoClientSettings.Builder`` class, call the :java-sync-api:`applyToSslSettings()
54-
<com/mongodb/MongoClientSettings.Builder.html#applyToSslSettings(com.mongodb.Block)>`
53+
``MongoClientSettings.Builder`` class, call the
54+
:java-docs:`applyToSslSettings() <apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html#applyToSslSettings(com.mongodb.Block)>`
5555
method. Set the ``enabled`` property to ``true`` in the ``SslSettings.Builder``
5656
block to enable TLS/SSL:
5757

source/fundamentals/crud/read-operations/geo.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Here is the location of MongoDB headquarters in GeoJSON:
4040
}
4141

4242
For definitive information on GeoJSON, see the
43-
:rfc:`official IETF specification <7946>`.
43+
`official IETF specification <https://datatracker.ietf.org/doc/html/rfc7946>`__.
4444

4545
.. external resource
4646

source/fundamentals/crud/read-operations/sort.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,7 @@ You can specify the order of the results of a
304304
:manual:`text search </text-search/>` by how closely the string values of
305305
each result's fields specified by the collection's text index match your search
306306
string. The text search assigns a numerical
307-
:manual:`text score </reference/operator/aggregation/meta/#exp._S_meta>` to
307+
:manual:`text score </reference/operator/aggregation/meta/>` to
308308
indicate how closely each result matches the search string. Use the
309309
``Sorts.metaTextScore()`` static factory method to build your sort criteria to
310310
sort by the text score.

source/fundamentals/crud/write-operations/insert.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ Your output should look something like this:
161161
For additional information on the classes and methods mentioned in this
162162
section, see the following resources:
163163

164-
- :java-sync-api:`API Documentation on insertMany() <com/mongodb/client/MongoCollection.html#insertMany>`
164+
- :java-docs:`API Documentation on insertMany() <apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#insertMany(java.util.List)>`
165165
- :java-docs:`API Documentation on InsertManyResult <apidocs/mongodb-driver-core/com/mongodb/client/result/InsertManyResult.html>`
166166
- :manual:`Manual Explanation on insertMany() </reference/method/db.collection.insertMany/>`
167167
- :doc:`Runnable Insert Multiple Documents Example </usage-examples/insertMany>`

0 commit comments

Comments
 (0)