DOCSP-49868 - MongoUrl #629

mongoKart · 2025-05-09T16:41:42Z

There are lots of small grammar changes in this PR. These are the only files that need tech review:

source/connect/connection-options.txt
source/connect/mongoclient.txt
source/includes/fundamentals/code-examples/connection/ConnectionOptions.cs
includes/fundamentals/connection-options/*.rst

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-49868

Staging Links

connect/connection-options

connect/connection-options/stable-api

connect/mongoclient

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Did you run a spell-check?
Did you run a grammar-check?
Are all the links working?
Are the facets and meta keywords accurate?
Are the page titles greater than 20 characters long and SEO relevant?

netlify · 2025-05-09T16:41:46Z

✅ Deploy Preview for docs-csharp ready!

Name	Link
🔨 Latest commit	`ed1a52d`
🔍 Latest deploy log	https://app.netlify.com/projects/docs-csharp/deploys/6842f7b22db5eb0008773fb6
😎 Deploy Preview	https://deploy-preview-629--docs-csharp.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

rustagir

mostly minor changes but i think itll be good to get a second review in!

source/connect/connection-options.txt

rustagir · 2025-05-29T19:36:50Z

source/connect/connection-options.txt

+
+To learn more about the options that you can specify in a connection URI, see
+:manual:`Connection String Options </reference/connection-string-options>` in the
+mdb-server+} manual.


Suggested change

+mdb-server+} manual.

{+mdb-server+} manual.

rustagir · 2025-05-29T19:39:21Z

source/connect/connection-options.txt

 To use a ``MongoClientSettings`` object, create an instance of the class, set
 its properties, and pass it as an argument to the ``MongoClient`` constructor:


S: not in your PR but suggest updating this for clarity

Suggested change

To use a ``MongoClientSettings`` object, create an instance of the class, set

its properties, and pass it as an argument to the ``MongoClient`` constructor:

To set options in a ``MongoClientSettings`` object, perform the following actions:

1. Create an instance of the ``MongoClientSettings``,

2. Set connection properties

3. Pass it as an argument to the ``MongoClient`` constructor

The following code demonstrates how to..

rustagir · 2025-05-29T19:40:05Z

source/connect/connection-options.txt

+as shown in the following example. This is useful if you already have a connection string
+but want to modify some of the settings programmatically, or if you need to specify settings


Suggested change

as shown in the following example. This is useful if you already have a connection string

but want to modify some of the settings programmatically, or if you need to specify settings

as shown in the following example. This is useful if you already have a connection string

but want to modify some settings programmatically, or if you want to specify settings

rustagir · 2025-05-29T19:40:28Z

source/connect/connection-options.txt

+object, as shown in the following example. This is useful if you already have a ``MongoUrl``
+object but need to specify settings that aren't available in the ``MongoUrl`` class.


Suggested change

object, as shown in the following example. This is useful if you already have a ``MongoUrl``

object but need to specify settings that aren't available in the ``MongoUrl`` class.

object, as shown in the following example. This is useful if you already have a ``MongoUrl``

object but want to specify settings that aren't available in the ``MongoUrl`` class.

rustagir · 2025-05-29T19:41:04Z

source/connect/connection-options.txt

+   :start-after: // start-mongo-client-settings
+   :end-before: // end-mongo-client-settings


S: Update to use the right code include

rustagir · 2025-05-29T19:41:53Z

source/connect/connection-options.txt

 .. literalinclude:: /includes/fundamentals/code-examples/connection/MongoClientSettingsConfig.cs
   :language: csharp
   :dedent:
   :start-after: // start mongo client settings config
   :end-before: // end mongo client settings config


I: example not rendering

source/connect/connection-options.txt

rustagir

can take another look if needed - mostly pointed out small stuff. Great work!

rustagir · 2025-06-02T18:10:30Z

source/connect/connection-options.txt

-This section describes the MongoDB connection and authentication options
-available in the {+driver-short+}. You can configure your connection using either
-the connection URI or a ``MongoClientSettings`` object.
+--------


S: I think it works but I dont think we need to add the title formatting above and below, just below
ie

Overview --------

yeah it makes the formatting confusing for the rest of the page. changed

rustagir · 2025-06-02T18:10:49Z

source/connect/connection-options.txt

+---------------------------------
+How to Specify Connection Options
+---------------------------------


S: same as above, remove above title overline

rustagir · 2025-06-02T18:12:20Z

source/connect/connection-options.txt

+.. literalinclude:: /includes/fundamentals/code-examples/connection/MongoClientSettingsConfig.cs
+   :language: csharp
+   :dedent: 8
+   :start-after: // start-mongo-url-builder
+   :end-before: // end-mongo-url-builder


S: code example not rendering

rustagir · 2025-06-02T18:12:31Z

source/connect/connection-options.txt

+   :start-after: // start-mongo-url-builder
+   :end-before: // end-mongo-url-builder
+
+------------------


S: dont need overline

source/connect/connection-options.txt

rustagir · 2025-06-02T18:18:37Z

source/connect/connection-options.txt

+   :start-after: // start-settings-read-encoding
+   :end-before: // end-settings-read-encodin


Suggested change

:start-after: // start-settings-read-encoding

:end-before: // end-settings-read-encodin

:start-after: // start-settings-read-encoding

:end-before: // end-settings-read-encoding

rustagir · 2025-06-02T18:19:22Z

source/connect/connection-options.txt

+      Indicates whether the settings have been frozen. Frozen settings can't be changed.
+      This option is read-only. The default value is ``false``.


Suggested change

Indicates whether the settings have been frozen. Frozen settings can't be changed.

This option is read-only. The default value is ``false``.

Indicates whether the settings have been frozen. You cannot change frozen settings.

This option is read-only. The default value is ``false``.

rustagir · 2025-06-02T18:19:43Z

source/connect/connection-options.txt

+         Alternatively, you can call the `FrozenCopy() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.FrozenCopy.html>`__
+         method to create a new ``MongoClientSettings`` object with the current settings frozen.


S: newline the link for readability

Suggested change

Alternatively, you can call the `FrozenCopy() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.FrozenCopy.html>`__

method to create a new ``MongoClientSettings`` object with the current settings frozen.

Alternatively, you can call the `FrozenCopy()

<{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.FrozenCopy.html>`__

method to create a new ``MongoClientSettings`` object with the current settings frozen.

rustagir · 2025-06-02T18:20:27Z

source/connect/connection-options.txt

+======================
+Additional Information
+======================


S: convert to regular h2 underline

Additional Information ----------------------

i have no idea how the headings on this page got so out of whack 🙃

rustagir · 2025-06-02T18:21:10Z

source/includes/fundamentals/connection-options/loadBalanced.rst

+Specifies whether the driver is connecting to a load balancer. You can set this
+property to ``true`` only if:


Suggested change

Specifies whether the driver is connecting to a load balancer. You can set this

property to ``true`` only if:

Specifies whether the driver is connecting to a load balancer. You can set this

property to ``true`` only in the following situations:

it's just one situation (when all the criteria are met), but I did reword it

rustagir

overall looks really good, i would suggest resolving the vale errors that you can, but its not blocking

rustagir · 2025-06-06T13:33:46Z

source/connect/connection-options.txt

+   :language: csharp
+   :dedent: 8
+   :start-after: // start-mongo-url-builder
+   :end-before: // end-mongo-url-builder

 Connection Options
 ------------------



S: Consider adding a short intro to the sections here i.e. "The following sections describe how to set connection options in the xxx and yyy"

whoops, lost that while testing heading levels

rustagir · 2025-06-06T13:37:47Z

source/includes/fundamentals/code-examples/connection/ConnectionOptions.cs

+    public void ConnectionUriExample()
+    {
+        // start-connection-uri
+        const string connectionUri = "mongodb+srv:/localhost:27017/?connectTimeoutMS=60000&tls=true";


S: consider shortening the variable name so the options are more visible from under the cut

Suggested change

const string connectionUri = "mongodb+srv:/localhost:27017/?connectTimeoutMS=60000&tls=true";

const string uri = "mongodb+srv:/localhost:27017/?connectTimeoutMS=60000&tls=true";

mongoKart added 2 commits May 8, 2025 19:24

add mongoUrl to connection options

6d1755c

preview

7ce7f4c

mongoKart and others added 19 commits May 9, 2025 11:56

preview

7684220

preview

46bfcb6

test

3840080

test

778b78b

test tabs

499a44d

preview

f5e6460

test

648eaaa

empty repo

e1ffb6c

autobuilder

c34f7bd

autobuilder

ac3439c

wip

fad0d5b

wip

cd5a743

wip

a5b583f

first draft

6674826

first draft

bdf6dd6

wip

1c66f65

fix api links

3e42fd6

wip

a692968

fix

39dcffd

mongoKart marked this pull request as ready for review May 29, 2025 15:25

rustagir self-requested a review May 29, 2025 17:31

rustagir requested changes May 29, 2025

View reviewed changes

mongoKart added 3 commits May 29, 2025 17:28

add library info

dd10bc2

rr feedback

020be2d

fixes

d9c5d0a

mongoKart requested a review from rustagir May 30, 2025 16:28

rustagir approved these changes Jun 2, 2025

View reviewed changes

mongoKart added 7 commits June 5, 2025 17:59

rr feedback

0422478

longer title

5e98441

TOC title

24d67eb

formatting fixes

ebf3621

fixes

913c0ba

test

adb862a

TOC fix

86e4644

rustagir approved these changes Jun 6, 2025

View reviewed changes

vale errors

ed1a52d

mongoKart requested review from a team and sanych-sun and removed request for a team June 6, 2025 14:18

		To use a ``MongoClientSettings`` object, create an instance of the class, set
		its properties, and pass it as an argument to the ``MongoClient`` constructor:

-To use a ``MongoClientSettings`` object, create an instance of the class, set
-its properties, and pass it as an argument to the ``MongoClient`` constructor:
+To set options in a ``MongoClientSettings`` object, perform the following actions:
+. Create an instance of the ``MongoClientSettings``,
+. Set connection properties
+. Pass it as an argument to the ``MongoClient`` constructor
+The following code demonstrates how to..

		as shown in the following example. This is useful if you already have a connection string
		but want to modify some of the settings programmatically, or if you need to specify settings

		object, as shown in the following example. This is useful if you already have a ``MongoUrl``
		object but need to specify settings that aren't available in the ``MongoUrl`` class.

		:start-after: // start-mongo-client-settings
		:end-before: // end-mongo-client-settings

		:start-after: // start-settings-read-encoding
		:end-before: // end-settings-read-encodin

		Indicates whether the settings have been frozen. Frozen settings can't be changed.
		This option is read-only. The default value is ``false``.

		Alternatively, you can call the `FrozenCopy() <{+new-api-root+}/MongoDB.Driver/MongoDB.Driver.MongoClientSettings.FrozenCopy.html>`__
		method to create a new ``MongoClientSettings`` object with the current settings frozen.

		Specifies whether the driver is connecting to a load balancer. You can set this
		property to ``true`` only if:

	const string connectionUri = "mongodb+srv:/localhost:27017/?connectTimeoutMS=60000&tls=true";
	const string uri = "mongodb+srv:/localhost:27017/?connectTimeoutMS=60000&tls=true";

DOCSP-49868 - MongoUrl #629

Are you sure you want to change the base?

DOCSP-49868 - MongoUrl #629

Uh oh!

Conversation

mongoKart commented May 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Info

Staging Links

Self-Review Checklist

Uh oh!

netlify bot commented May 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-csharp ready!

Uh oh!

rustagir left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

rustagir left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rustagir left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mongoKart commented May 9, 2025 •

edited

Loading

netlify bot commented May 9, 2025 •

edited

Loading