Skip to content

DOCSP-48376: Get Started edits #1039

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Mar 19, 2025
Merged

DOCSP-48376: Get Started edits #1039

merged 3 commits into from
Mar 19, 2025

Conversation

norareidy
Copy link
Collaborator

@norareidy norareidy commented Mar 19, 2025 •
edited
Loading

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-48376
Staging - https://deploy-preview-1039--docs-node.netlify.app/get-started/

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 Netlify
Copy link

netlify bot commented Mar 19, 2025 •
edited
Loading

✅ Deploy Preview for docs-node ready!

Name Link
🔨 Latest commit 9d9a7af
🔍 Latest deploy log https://app.netlify.com/sites/docs-node/deploys/67db272205a93e00087a5a45
😎 Deploy Preview https://deploy-preview-1039--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.

rustagir
rustagir approved these changes Mar 19, 2025
View reviewed changes
Copy link
Collaborator

@rustagir rustagir left a comment

Choose a reason for hiding this comment

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

lgtm % few small things

source/get-started.txt
Getting Started with Node.js
============================
=======================================
Getting Started with the Node.js Driver
Copy link
Collaborator

Choose a reason for hiding this comment

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

S: Consider using source constant

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

since "Driver" needs to be capitalized I'll leave as is

source/get-started.txt Outdated
Create a file to contain your application called ``index.js`` in your
``node_quickstart`` project directory.
In your ``node_quickstart`` directory, create a file called
``index.js`` to contain your application.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
``index.js`` to contain your application.
``index.js`` for your application.

@norareidy norareidy merged commit e516f18 into mongodb:comp-cov Mar 19, 2025
5 checks passed
@norareidy norareidy deleted the DOCSP-48376-single-get-started branch March 19, 2025 21:18
lindseymoore pushed a commit to lindseymoore/docs-node that referenced this pull request Apr 29, 2025
@norareidy @lindseymoore
DOCSP-48376: Get Started edits (mongodb#1039)
1f9e8f5 
* DOCSP-48376: Get Started edits

* edits

* RR feedback
lindseymoore added a commit that referenced this pull request Apr 29, 2025
@lindseymoore @stephmarie17
@norareidy @shuangela
Node CC merge comp-cov branch (#1096)
1e62fc0 
* 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
@lindseymoore @stephmarie17
@norareidy @shuangela
Node CC merge comp-cov branch (mongodb#1096)
df5acb5 
* 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
@lindseymoore @stephmarie17
@norareidy @shuangela
[Backport V6.16] Node CC (#1099)
2194d7e 
* 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
Reviewers

@rustagir rustagir rustagir approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@norareidy @rustagir