Skip to content

DOCSP-48378 make mongoclient page #1038

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Mar 21, 2025

Conversation

shuangela
Copy link
Collaborator

@shuangela shuangela commented Mar 19, 2025

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-48378
Staging - https://deploy-preview-1038--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?

Copy link

netlify bot commented Mar 19, 2025

Deploy Preview for docs-node ready!

Name Link
🔨 Latest commit 66806d1
🔍 Latest deploy log https://app.netlify.com/sites/docs-node/deploys/67dd91404aee4f000898915f
😎 Deploy Preview https://deploy-preview-1038--docs-node.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link
Collaborator

@norareidy norareidy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM + some suggestions!

Comment on lines 26 to 28
- A **connection URI**, also known as a *connection string*, which tells the
{+driver-short+} which MongoDB deployment to connect to.
- A **MongoClient** object, which creates the connection to and performs
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

S: you can remove the articles at the beginning of each bullet point

Suggested change
- A **connection URI**, also known as a *connection string*, which tells the
{+driver-short+} which MongoDB deployment to connect to.
- A **MongoClient** object, which creates the connection to and performs
- **Connection URI**, also known as a *connection string*, which tells the
{+driver-short+} which MongoDB deployment to connect to.
- **MongoClient** object, which creates the connection to and performs

- Optional. Authentication credentials. If you include these, the client
authenticates the user against the database specified in ``authSource``.
For more information about the ``authSource`` connection option,
see :ref:`node-troubleshooting-connection-admin`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

S: clarify where this link is going

Suggested change
see :ref:`node-troubleshooting-connection-admin`.
see :ref:`node-troubleshooting-connection-admin` in the Connection Troubleshooting guide.

Comment on lines 121 to 122
To learn more about the Stable
API feature, see the :ref:`{+stable-api+} page <nodejs-stable-api>`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

S:

Suggested change
To learn more about the Stable
API feature, see the :ref:`{+stable-api+} page <nodejs-stable-api>`.
To learn more about the {+stable-api+}
feature, see the :ref:`{+stable-api+} page <nodejs-stable-api>`.

Comment on lines 70 to 73
- Optional. The authentication database to use if the
connection string includes ``username:password@``
authentication credentials but not the ``authSource`` option. If you don't include
this component, the client authenticates the user against the ``admin`` database.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe worth mentioning this is the database that is used when calling client.db() with no argument?

@shuangela shuangela requested a review from nbbeeken March 21, 2025 16:25
@shuangela shuangela merged commit dd67575 into mongodb:comp-cov Mar 21, 2025
5 checks passed
lindseymoore pushed a commit to lindseymoore/docs-node that referenced this pull request Apr 29, 2025
* make mongoclient page

* fix link:

* fix link

* add anchor to page to avoid broken link

* nr feedback

* nb feedback

* monospace
lindseymoore added a commit that referenced this pull request Apr 29, 2025
* 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]>
lindseymoore added a commit to lindseymoore/docs-node that referenced this pull request Apr 30, 2025
* 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)
lindseymoore added a commit that referenced this pull request Apr 30, 2025
* 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants