DOCSP-48388 break up faq #1048

shuangela · 2025-03-26T15:27:36Z

Pull Request Info

JIRA - https://jira.mongodb.org/browse/DOCSP-48388
Staging - https://deploy-preview-1048--docs-node.netlify.app/connect/connection-options/
https://deploy-preview-1048--docs-node.netlify.app/connect/connection-options/connection-pools/
https://deploy-preview-1048--docs-node.netlify.app/connect/connection-troubleshooting/
https://deploy-preview-1048--docs-node.netlify.app/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?

netlify · 2025-03-26T15:27:58Z

✅ Deploy Preview for docs-node ready!

Name	Link
🔨 Latest commit	`a4110db`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-node/deploys/67e558cc8c85910008329902
😎 Deploy Preview	https://deploy-preview-1048--docs-node.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 site configuration.

jordan-smith721

Nice work! Just a few small things and one suggestion for moving a section

jordan-smith721 · 2025-03-26T18:41:43Z

source/connect/connection-options.txt

+------------------------------
+
+If you experience unexpected network behavior or if a MongoDB process
+fails with an error, you may not receive confirmation that the


Suggested change

fails with an error, you may not receive confirmation that the

fails with an error, you might not receive confirmation that the

jordan-smith721 · 2025-03-26T18:43:15Z

source/connect/connection-options.txt

+to your MongoDB deployment. This functionality only works if your
+operating system supports the ``SO_KEEPALIVE`` socket option.


Suggested change

to your MongoDB deployment. This functionality only works if your

operating system supports the ``SO_KEEPALIVE`` socket option.

to your MongoDB deployment. This functionality works only if your

operating system supports the ``SO_KEEPALIVE`` socket option.

jordan-smith721 · 2025-03-26T18:51:30Z

source/connect/connection-options/connection-pools.txt

This seems out of scope for the ticket this PR applies to, but I think it would be worth creating a ticket to clean this page up a bit. This Connection Pool Overview section is very long and would probably benefit from being broken up into sections now that it's in its own page instead of an FAQ.

Good idea, made a ticket here: https://jira.mongodb.org/browse/DOCSP-48683

jordan-smith721 · 2025-03-26T18:56:37Z

source/crud/read-write-pref.txt

+-----------------------------------
+
+The connection string passed to the driver must use exact hostnames for
+the servers as set in the :manual:`Replica Set Config </reference/replica-configuration/>`.


Suggested change

the servers as set in the :manual:`Replica Set Config </reference/replica-configuration/>`.

the servers, as set in the :manual:`Replica Set Config </reference/replica-configuration/>`.

jordan-smith721 · 2025-03-26T18:58:05Z

source/crud/read-write-pref.txt

+Given the following configuration settings for your Replica Set, in
+order for the Replica Set discovery and :manual:`failover


No need to capitalize replica set here:

Suggested change

Given the following configuration settings for your Replica Set, in

order for the Replica Set discovery and :manual:`failover

Given the following configuration settings for your replica set, in

order for the replica set discovery and :manual:`failover

jordan-smith721 · 2025-03-26T19:04:36Z

source/crud/read-write-pref.txt

+Connection Strings for Replica Sets
+-----------------------------------


I think this section would go better in either the "Connection Troubleshooting" page or the "Choose a Connection Target" page. It seems disconnected on a page about read/write preferences, even though this page is talking about replica sets.

jordan-smith721

LGTM!

source/connect/connection-options.txt

baileympearson

@shuangela I just want to confirm - the new sections were existing documentation moved to a new section? It is difficult to tell exactly what (if anything) changed in the large diffs.

source/connect/connection-options.txt

* break up faq * vale errors * fix vale error * wording * add redirect * remove faq * change headlines * js feedback * bp edits * bp feedback

* DOCSP-48375 ToC reorg part one (#1035) * DOCSP-48376: Get Started edits (#1039) * DOCSP-48376: Get Started edits * edits * RR feedback * DOCSP-48384: Atlas search (#1041) * DOCSP-48384: Atlas search * edits * tech feedback * DOCSP-48378 make mongoclient page (#1038) * make mongoclient page * fix link: * fix link * add anchor to page to avoid broken link * nr feedback * nb feedback * monospace * DOCSP-48383 document bson (#1044) * make bson page * edit code * fix spacing * capitalization * change copy * nb edits * DOCSP-48493: Databases & collections (#1045) * DOCSP-48493: Databases & collections * edits * SA feedback * typo * DOCSP-48385 Make Atlas Vector Search page (#1042) * make page * fix vale * remove extra space * add to index * fix link * fix link * fix quotes * fix quotes * lm feedback * fix spacing * remove extra code * fix spacing * fix link * fix link title * change copy * lm review * change spacing * lm edits * remove extra words * nb edits * remove extra quotes * fix quotes * add quote * change quote * nb feedback * DOCSP-48377 Authentication Reorg (#1040) * DOCSP-48377 Authentication Reorg * start building TOC * full draft * edits * edits * SA comments * SA update redirect * Edit table * DOCSP-48379 Connection Targets (#1043) * DOCSP-48379 Connection Targets * edits * edits * last edits * one more * ignoring vale check * eol for file * NR review * vale check * DOCSP-48381 make specify docs page (#1037) * make specify docs page * fix includes link * fix link * fix highlighting and links * remove passive * nr feedback * final edits * fix typo * nr feedback * tech review * fix wording * Fix spacing * spacing change * Update connection-targets.txt * Update access-cursor-note.rst * Update access-cursor-note.rst * DOCSP-48388 break up faq (#1048) * break up faq * vale errors * fix vale error * wording * add redirect * remove faq * change headlines * js feedback * bp edits * bp feedback * DOCSP-48592 Security Landing Page (#1064) * DOCSP-48592 Security Landing Page * remove sample app * change title * DOCSP-48608 Edit AVS and AS section on Indexes page (#1065) * DOCSP-48606 Atlas Vector Search * edit existing sections * Edits * edit code comments * add link to as query guide * title change * more edits * DOCSP-48382: Configure CRUD operations (#1049) * DOCSP-48382: Configure CRUD operations * edits, move info * edits * AS feedback * tech feedback * DOCSP-48386 Add monitoring page (#1046) * DOCSP-48683 Refine Connection Pools page (#1067) * DOCSP-48501 add casual consistency section (#1047) * add casual consistency section: * change find to findone * DOCSP-49031 UUID (#1072) * DOCSP-48717 UUID * DOCSP-49031 UUID * edits * edit import * edit * edit * JS review * tech review * DOCSP-48390 Document Data Formats: EJSON (#1069) * DOCSP-48390 Document Data Formats: EJSON * add to toc and bson import note * edit * add binary type * edit ouputs * remove additional info section * last small edits * fix link * edit * tech review * edits * tech review 2 * add note about bad orange highlighting * tech review * DOCSP-48487 Move usage examples (#1071) * DOCSP-48389 Connection Troubleshooting Revisions (#1068) * DOCSP-48389 Connection Troubleshooting Revisions * tech question * edits * tech review * edit * remov * technical review * security comment * JS review * edit * DOCSP-48707 Standardize cursor chaining methods (#1073) * DOCSP-48707 Standardize cursor chaining methods * tech review * edits * vale check * remove mention of options object * order comment * RR review * DOCSP-48708 Specify cursor limitations (#1094) * DOCSP-48708 Specify cursor limitations * add chaining method to find * edit * edit find ts example * SA review * change cursor chain const names to be more specific * DOCSP-48497 Comp cov clean up (#1095) * add back old refs * get started --------- Co-authored-by: Stephanie <[email protected]> Co-authored-by: Nora Reidy <[email protected]> Co-authored-by: shuangela <[email protected]>

* DOCSP-48375 ToC reorg part one (mongodb#1035) * DOCSP-48376: Get Started edits (mongodb#1039) * DOCSP-48376: Get Started edits * edits * RR feedback * DOCSP-48384: Atlas search (mongodb#1041) * DOCSP-48384: Atlas search * edits * tech feedback * DOCSP-48378 make mongoclient page (mongodb#1038) * make mongoclient page * fix link: * fix link * add anchor to page to avoid broken link * nr feedback * nb feedback * monospace * DOCSP-48383 document bson (mongodb#1044) * make bson page * edit code * fix spacing * capitalization * change copy * nb edits * DOCSP-48493: Databases & collections (mongodb#1045) * DOCSP-48493: Databases & collections * edits * SA feedback * typo * DOCSP-48385 Make Atlas Vector Search page (mongodb#1042) * make page * fix vale * remove extra space * add to index * fix link * fix link * fix quotes * fix quotes * lm feedback * fix spacing * remove extra code * fix spacing * fix link * fix link title * change copy * lm review * change spacing * lm edits * remove extra words * nb edits * remove extra quotes * fix quotes * add quote * change quote * nb feedback * DOCSP-48377 Authentication Reorg (mongodb#1040) * DOCSP-48377 Authentication Reorg * start building TOC * full draft * edits * edits * SA comments * SA update redirect * Edit table * DOCSP-48379 Connection Targets (mongodb#1043) * DOCSP-48379 Connection Targets * edits * edits * last edits * one more * ignoring vale check * eol for file * NR review * vale check * DOCSP-48381 make specify docs page (mongodb#1037) * make specify docs page * fix includes link * fix link * fix highlighting and links * remove passive * nr feedback * final edits * fix typo * nr feedback * tech review * fix wording * Fix spacing * spacing change * Update connection-targets.txt * Update access-cursor-note.rst * Update access-cursor-note.rst * DOCSP-48388 break up faq (mongodb#1048) * break up faq * vale errors * fix vale error * wording * add redirect * remove faq * change headlines * js feedback * bp edits * bp feedback * DOCSP-48592 Security Landing Page (mongodb#1064) * DOCSP-48592 Security Landing Page * remove sample app * change title * DOCSP-48608 Edit AVS and AS section on Indexes page (mongodb#1065) * DOCSP-48606 Atlas Vector Search * edit existing sections * Edits * edit code comments * add link to as query guide * title change * more edits * DOCSP-48382: Configure CRUD operations (mongodb#1049) * DOCSP-48382: Configure CRUD operations * edits, move info * edits * AS feedback * tech feedback * DOCSP-48386 Add monitoring page (mongodb#1046) * DOCSP-48683 Refine Connection Pools page (mongodb#1067) * DOCSP-48501 add casual consistency section (mongodb#1047) * add casual consistency section: * change find to findone * DOCSP-49031 UUID (mongodb#1072) * DOCSP-48717 UUID * DOCSP-49031 UUID * edits * edit import * edit * edit * JS review * tech review * DOCSP-48390 Document Data Formats: EJSON (mongodb#1069) * DOCSP-48390 Document Data Formats: EJSON * add to toc and bson import note * edit * add binary type * edit ouputs * remove additional info section * last small edits * fix link * edit * tech review * edits * tech review 2 * add note about bad orange highlighting * tech review * DOCSP-48487 Move usage examples (mongodb#1071) * DOCSP-48389 Connection Troubleshooting Revisions (mongodb#1068) * DOCSP-48389 Connection Troubleshooting Revisions * tech question * edits * tech review * edit * remov * technical review * security comment * JS review * edit * DOCSP-48707 Standardize cursor chaining methods (mongodb#1073) * DOCSP-48707 Standardize cursor chaining methods * tech review * edits * vale check * remove mention of options object * order comment * RR review * DOCSP-48708 Specify cursor limitations (mongodb#1094) * DOCSP-48708 Specify cursor limitations * add chaining method to find * edit * edit find ts example * SA review * change cursor chain const names to be more specific * DOCSP-48497 Comp cov clean up (mongodb#1095) * add back old refs * get started --------- Co-authored-by: Stephanie <[email protected]> Co-authored-by: Nora Reidy <[email protected]> Co-authored-by: shuangela <[email protected]> (cherry picked from commit 1e62fc0)

* Node CC merge comp-cov branch (#1096) * DOCSP-48375 ToC reorg part one (#1035) * DOCSP-48376: Get Started edits (#1039) * DOCSP-48376: Get Started edits * edits * RR feedback * DOCSP-48384: Atlas search (#1041) * DOCSP-48384: Atlas search * edits * tech feedback * DOCSP-48378 make mongoclient page (#1038) * make mongoclient page * fix link: * fix link * add anchor to page to avoid broken link * nr feedback * nb feedback * monospace * DOCSP-48383 document bson (#1044) * make bson page * edit code * fix spacing * capitalization * change copy * nb edits * DOCSP-48493: Databases & collections (#1045) * DOCSP-48493: Databases & collections * edits * SA feedback * typo * DOCSP-48385 Make Atlas Vector Search page (#1042) * make page * fix vale * remove extra space * add to index * fix link * fix link * fix quotes * fix quotes * lm feedback * fix spacing * remove extra code * fix spacing * fix link * fix link title * change copy * lm review * change spacing * lm edits * remove extra words * nb edits * remove extra quotes * fix quotes * add quote * change quote * nb feedback * DOCSP-48377 Authentication Reorg (#1040) * DOCSP-48377 Authentication Reorg * start building TOC * full draft * edits * edits * SA comments * SA update redirect * Edit table * DOCSP-48379 Connection Targets (#1043) * DOCSP-48379 Connection Targets * edits * edits * last edits * one more * ignoring vale check * eol for file * NR review * vale check * DOCSP-48381 make specify docs page (#1037) * make specify docs page * fix includes link * fix link * fix highlighting and links * remove passive * nr feedback * final edits * fix typo * nr feedback * tech review * fix wording * Fix spacing * spacing change * Update connection-targets.txt * Update access-cursor-note.rst * Update access-cursor-note.rst * DOCSP-48388 break up faq (#1048) * break up faq * vale errors * fix vale error * wording * add redirect * remove faq * change headlines * js feedback * bp edits * bp feedback * DOCSP-48592 Security Landing Page (#1064) * DOCSP-48592 Security Landing Page * remove sample app * change title * DOCSP-48608 Edit AVS and AS section on Indexes page (#1065) * DOCSP-48606 Atlas Vector Search * edit existing sections * Edits * edit code comments * add link to as query guide * title change * more edits * DOCSP-48382: Configure CRUD operations (#1049) * DOCSP-48382: Configure CRUD operations * edits, move info * edits * AS feedback * tech feedback * DOCSP-48386 Add monitoring page (#1046) * DOCSP-48683 Refine Connection Pools page (#1067) * DOCSP-48501 add casual consistency section (#1047) * add casual consistency section: * change find to findone * DOCSP-49031 UUID (#1072) * DOCSP-48717 UUID * DOCSP-49031 UUID * edits * edit import * edit * edit * JS review * tech review * DOCSP-48390 Document Data Formats: EJSON (#1069) * DOCSP-48390 Document Data Formats: EJSON * add to toc and bson import note * edit * add binary type * edit ouputs * remove additional info section * last small edits * fix link * edit * tech review * edits * tech review 2 * add note about bad orange highlighting * tech review * DOCSP-48487 Move usage examples (#1071) * DOCSP-48389 Connection Troubleshooting Revisions (#1068) * DOCSP-48389 Connection Troubleshooting Revisions * tech question * edits * tech review * edit * remov * technical review * security comment * JS review * edit * DOCSP-48707 Standardize cursor chaining methods (#1073) * DOCSP-48707 Standardize cursor chaining methods * tech review * edits * vale check * remove mention of options object * order comment * RR review * DOCSP-48708 Specify cursor limitations (#1094) * DOCSP-48708 Specify cursor limitations * add chaining method to find * edit * edit find ts example * SA review * change cursor chain const names to be more specific * DOCSP-48497 Comp cov clean up (#1095) * add back old refs * get started --------- Co-authored-by: Stephanie <[email protected]> Co-authored-by: Nora Reidy <[email protected]> Co-authored-by: shuangela <[email protected]> (cherry picked from commit 1e62fc0) * Backport v6.16 NodeCC * fix redirect --------- Co-authored-by: Stephanie <[email protected]> Co-authored-by: Nora Reidy <[email protected]> Co-authored-by: shuangela <[email protected]>

break up faq

38d3c38

shuangela added 6 commits March 26, 2025 11:56

vale errors

64be668

fix vale error

00ef1a6

wording

7b464e7

add redirect

435d1d5

remove faq

ab145a7

change headlines

b950168

jordan-smith721 requested changes Mar 26, 2025

View reviewed changes

js feedback

4eb57f3

shuangela requested a review from jordan-smith721 March 26, 2025 19:33

jordan-smith721 approved these changes Mar 26, 2025

View reviewed changes

baileympearson reviewed Mar 26, 2025

View reviewed changes

source/connect/connection-options.txt Outdated Show resolved Hide resolved

bp edits

eb0ecb3

shuangela requested a review from baileympearson March 26, 2025 20:33

baileympearson requested changes Mar 26, 2025

View reviewed changes

source/connect/connection-options.txt Outdated Show resolved Hide resolved

source/connect/connection-options.txt Outdated Show resolved Hide resolved

source/connect/connection-options.txt Outdated Show resolved Hide resolved

bp feedback

a4110db

shuangela requested a review from baileympearson March 27, 2025 19:15

baileympearson approved these changes Mar 28, 2025

View reviewed changes

shuangela merged commit 63c24f3 into mongodb:comp-cov Mar 31, 2025
5 checks passed

lindseymoore pushed a commit to lindseymoore/docs-node that referenced this pull request Apr 29, 2025

DOCSP-48388 break up faq (mongodb#1048)

5a5b43c

* break up faq * vale errors * fix vale error * wording * add redirect * remove faq * change headlines * js feedback * bp edits * bp feedback

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

DOCSP-48388 break up faq #1048

DOCSP-48388 break up faq #1048

Uh oh!

shuangela commented Mar 26, 2025 •

edited

Loading

Uh oh!

netlify bot commented Mar 26, 2025 •

edited

Loading

Uh oh!

jordan-smith721 left a comment

Uh oh!

jordan-smith721 Mar 26, 2025

Uh oh!

jordan-smith721 Mar 26, 2025

Uh oh!

jordan-smith721 Mar 26, 2025

Uh oh!

shuangela Mar 26, 2025

Uh oh!

jordan-smith721 Mar 26, 2025

Uh oh!

jordan-smith721 Mar 26, 2025

Uh oh!

jordan-smith721 Mar 26, 2025

Uh oh!

jordan-smith721 left a comment

Uh oh!

Uh oh!

baileympearson left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

	fails with an error, you may not receive confirmation that the
	fails with an error, you might not receive confirmation that the

		to your MongoDB deployment. This functionality only works if your
		operating system supports the ``SO_KEEPALIVE`` socket option.

	the servers as set in the :manual:`Replica Set Config </reference/replica-configuration/>`.
	the servers, as set in the :manual:`Replica Set Config </reference/replica-configuration/>`.

		Given the following configuration settings for your Replica Set, in
		order for the Replica Set discovery and :manual:`failover

		Connection Strings for Replica Sets
		-----------------------------------

DOCSP-48388 break up faq #1048

DOCSP-48388 break up faq #1048

Uh oh!

Conversation

shuangela commented Mar 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Info

Self-Review Checklist

Uh oh!

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

Uh oh!

✅ Deploy Preview for docs-node ready!

Uh oh!

jordan-smith721 left a comment

Choose a reason for hiding this comment

Uh oh!

jordan-smith721 Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

jordan-smith721 Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

jordan-smith721 Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

shuangela Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

jordan-smith721 Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

jordan-smith721 Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

jordan-smith721 Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

jordan-smith721 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

baileympearson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shuangela commented Mar 26, 2025 •

edited

Loading

netlify bot commented Mar 26, 2025 •

edited

Loading