DOCSP-59346 Connection Option Template by lindseymoore · Pull Request #158 · 10gen/docs-shared

lindseymoore · 2026-04-20T21:36:33Z

Jira: https://jira.mongodb.org/browse/DOCSP-59346

Creates a template for new Connection Options page format and option descriptions for page.

Option descriptions and template are adapted from the current C Driver Connection Options page.

stephmarie17

Awesome work, Lindsey! This will make the connection options revamp so much easier. Left some comments and a few questions, mostly around whether all the :manual: links should be updated to use :ref:, and some usage suggestions.

stephmarie17 · 2026-04-21T16:43:45Z

+If you specify this option, the driver doesn't accept the
+SRV connection format. You must use the standard connection URI format
+instead. To learn more about the SRV connection
+and the standard connection formats, see the :manual:`Connection Strings </reference/connection-string/>`


[q] Are we still planning to move :manual: links to :ref:?

Suggested change

and the standard connection formats, see the :manual:`Connection Strings </reference/connection-string/>`

and the standard connection formats, see the :ref:`Connection Strings <mongodb-uri>`

If so, applies to all.

Thanks, replaced all :manuals: links!

stephmarie17 · 2026-04-21T16:55:45Z

@@ -0,0 +1,1305 @@
+.. _c-connection-options:


[s] Maybe rename this so it's clearer it's meant to be changed and doesn't accidentally get carried over to another driver:

Suggested change

.. _c-connection-options:

.. _template-connection-options:

Good idea! Replaced all instances of 'c' in refs to 'template'

stephmarie17 · 2026-04-21T16:57:46Z

+How to Specify Connection Options
+---------------------------------
+
+.. TODO: Replace these sections with whatever methods for specify the connection option. 


Suggested change

.. TODO: Replace these sections with whatever methods for specify the connection option.

.. TODO: Replace these sections with whatever methods the driver you are documenting supports for specifying the connection option.

stephmarie17 · 2026-04-21T17:04:45Z

+      *Data Type* : 
+
+      *Default Value* : 


[q] Are these required? Just wondering as the existing C driver page doesn't have this part so curious how it looks when rendered and if they are required to have a value specific to each driver?

I started on C; here's what it will look like rendered: https://deploy-preview-19608--mongodb-c-driver.netlify.app/docs/languages/c/c-driver/upcoming/connect/connection-options/#replica-set-options

Please let me know what you think of how it looks!

We will have to hunt down the data type and defaults values for each of these options. Some drivers already have this info, some don't.

Gotcha that makes sense! I think that preview looks good maybe use bold instead of italics, similar to how we format the text in the tables? What do you think?

stephmarie17 · 2026-04-21T17:08:20Z

+      You can set the read concern level by using the ``MONGOC_URI_READCONCERNLEVEL`` option:
+
+      .. literalinclude::
+         :language:
+         :copyable: true
+         :dedent:
+         :start-after:
+         :end-before:
+
+      You can also set the read concern level by using a ``mongoc_read_concern_t`` structure:


[q] Is this also driver-specific and should it include a TODO to call it out?

stephmarie17 · 2026-04-21T17:08:43Z

+      You can set the read preference by using a ``mongoc_read_prefs_t`` structure:
+
+      .. literalinclude::
+         :language:
+         :copyable: true
+         :dedent:
+         :start-after:
+         :end-before:
+
+      You can also set the read preference by using the ``MONGOC_URI_READPREFERENCE`` option:


Same question 😅

stephmarie17 · 2026-04-21T17:09:00Z

+         :start-after:
+         :end-before:
+
+      You can also set the max staleness by using a ``mongoc_read_prefs_t`` structure:


stephmarie17 · 2026-04-21T17:11:54Z

@@ -0,0 +1,1305 @@
+.. _c-connection-options:
+
+.. NOTE: Meant to be copied and used as a template for the connection options page. 


[s] Suggestion to explain the usage of this doc more:

Suggested change

.. NOTE: Meant to be copied and used as a template for the connection options page.

.. NOTE: You can use this template for the connection options page in a drivers documentation set. Copy this content into the corresponding page for the driver you are documenting, and replace and edit content as needed. This is not meant to be used as a shared include.

In case writers think they can include this and then use replace or something for whatever their specific content is.

Perfect, thanks!

stephmarie17

LGTM! Left a suggestion in one comment.

stephmarie17 · 2026-04-21T23:15:56Z

+      *Data Type* : 
+
+      *Default Value* : 


Gotcha that makes sense! I think that preview looks good maybe use bold instead of italics, similar to how we format the text in the tables? What do you think?

lindseymoore added 5 commits April 20, 2026 17:35

DOCSP-59346 Connection Option Template

70cc9fc

edits

32c0b56

fix TODO

4f8640a

final edits

1029490

add note up top

4556547

stephmarie17 requested changes Apr 21, 2026

View reviewed changes

SA review

8b36a27

lindseymoore requested a review from stephmarie17 April 21, 2026 22:00

stephmarie17 approved these changes Apr 21, 2026

View reviewed changes

bold info headings

c1720fe

lindseymoore merged commit 71e95bc into 10gen:main Apr 22, 2026

	and the standard connection formats, see the :manual:`Connection Strings </reference/connection-string/>`
	and the standard connection formats, see the :ref:`Connection Strings <mongodb-uri>`

	.. TODO: Replace these sections with whatever methods for specify the connection option.
	.. TODO: Replace these sections with whatever methods the driver you are documenting supports for specifying the connection option.

		@@ -0,0 +1,1305 @@
		.. _c-connection-options:

		.. NOTE: Meant to be copied and used as a template for the connection options page.

	.. NOTE: Meant to be copied and used as a template for the connection options page.
	.. NOTE: You can use this template for the connection options page in a drivers documentation set. Copy this content into the corresponding page for the driver you are documenting, and replace and edit content as needed. This is not meant to be used as a shared include.

Conversation

lindseymoore commented Apr 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stephmarie17 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!

lindseymoore Apr 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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!

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!

stephmarie17 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

lindseymoore commented Apr 20, 2026 •

edited

Loading

lindseymoore Apr 21, 2026 •

edited

Loading