Skip to content

Commit 94ce33e

Browse files
johnnyshieldsp
andauthored
Fix MONGOID-5006 Link default auth source documentation to driver instead of incorrectly claiming "admin" is always the default (#5048)
* MONGOID-5006: Default auth source should link to driver instead of incorrectly claiming "admin" is always the default * Fix more broken links * Update callbacks.txt * Update tutorials.txt * client --> driver * tweak the language * Mr. Shields' suggestion * More terse langauge + link to server docs * Typo Co-authored-by: shields <[email protected]> Co-authored-by: Oleg Pudeyev <[email protected]>
1 parent ad4fe72 commit 94ce33e

File tree

3 files changed

+13
-7
lines changed

3 files changed

+13
-7
lines changed

source/reference/configuration.txt

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ can be configured.
139139
- myhost3.mydomain.com:27017
140140
options:
141141
# These options are Ruby driver options, documented in
142-
# https://docs.mongodb.com/ruby-driver/current/tutorials/ruby-driver-create-client/
142+
# https://docs.mongodb.com/ruby-driver/current/reference/create-client/
143143

144144
# Change the default write concern. (default = { w: 1 })
145145
write:
@@ -168,7 +168,13 @@ can be configured.
168168
# on 2.4 and 2.6 is :plain)
169169
auth_mech: :scram
170170

171-
# The database or source to authenticate the user against. (default: admin)
171+
# Specify the auth source, i.e. the database or other source which
172+
# contains the user's login credentials. Allowed values for auth source
173+
# depend on the authentication mechanism, as explained in the server documentation:
174+
# https://docs.mongodb.com/manual/reference/connection-string/#mongodb-urioption-urioption.authSource
175+
# If no auth source is specified, the default auth source as
176+
# determined by the driver will be used. Please refer to:
177+
# https://docs.mongodb.com/ruby-driver/current/reference/authentication/#auth-source
172178
auth_source: admin
173179

174180
# Force the driver to connect in a specific way instead of auto-
@@ -291,7 +297,7 @@ can be configured.
291297
use_utc: false
292298

293299
The Ruby driver options may be found in
294-
`the driver documentation <https://docs.mongodb.com/ruby-driver/current/tutorials/ruby-driver-create-client/>`_.
300+
`the driver documentation <https://docs.mongodb.com/ruby-driver/current/reference/create-client/>`_.
295301

296302
ERb Preprocessing
297303
=================
@@ -596,7 +602,7 @@ be executed sequentially during socket creation.
596602
in an application.
597603

598604
For more information about TLS context hooks, including best practices for
599-
assigning and removing them, see `the Ruby driver documentation <https://docs.mongodb.com/ruby-driver/current/tutorials/ruby-driver-create-client/#modifying-sslcontext>`_.
605+
assigning and removing them, see `the Ruby driver documentation <https://docs.mongodb.com/ruby-driver/current/reference/create-client/#modifying-sslcontext>`_.
600606

601607
Usage with Forking Servers
602608
==========================

source/reference/queries.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1107,7 +1107,7 @@ the query cache. When using driver versions 2.14.0 or newer, this interface
11071107
will affect the driver query cache.
11081108

11091109
Read more about the Ruby driver query cache
1110-
`in the driver documentation <https://docs.mongodb.com/ruby-driver/current/tutorials/query-cache/>`_.
1110+
`in the driver documentation <https://docs.mongodb.com/ruby-driver/current/reference/query-cache/>`_.
11111111

11121112
.. warning::
11131113

@@ -1118,7 +1118,7 @@ Read more about the Ruby driver query cache
11181118
recommended that you upgrade to Ruby driver version 2.14.0 or newer.
11191119

11201120
Read more about the Ruby driver query cache
1121-
`in the driver documentation <https://docs.mongodb.com/ruby-driver/current/tutorials/query-cache/>`_.
1121+
`in the driver documentation <https://docs.mongodb.com/ruby-driver/current/reference/query-cache/>`_.
11221122

11231123
Legacy Query Cache Limitations
11241124
------------------------------

source/release-notes/mongoid-7.2.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -402,7 +402,7 @@ Mongoid query cache. If you plan to use the query cache, it is recommended
402402
that you upgrade to driver version 2.14.
403403

404404
To read more about the query cache improvements made in the driver, see
405-
`the Ruby driver documentation <https://docs.mongodb.com/ruby-driver/current/tutorials/query-cache/>`_.
405+
`the Ruby driver documentation <https://docs.mongodb.com/ruby-driver/current/reference/query-cache/>`_.
406406

407407
To read more about using the query cache with Mongoid and the limitations
408408
of the legacy query cache, see :ref:`the query cache documentation <query-cache>`.

0 commit comments

Comments
 (0)