docs(NODE-2329): write upgrade and migration guide #2890

nbbeeken · 2021-07-07T20:01:56Z

Upgrade guide, moved the versioned api feature mention out of this file, I'm thinking we should break out features from changes, thoughts?

emadum

Looking great, thank you for putting this together! 👏 Had a few small requests.

docs/CHANGES_4.0.0.md

Co-authored-by: Eric Adum <[email protected]>

docs/CHANGES_4.0.0.md

dariakp · 2021-07-08T14:58:26Z

docs/CHANGES_4.0.0.md

+  - Use command monitoring: `client.on('commandStarted', (ev) => {})`
+- Top-Level export no longer a function: `typeof require('mongodb') !== 'function'`
+  - Must construct a MongoClient and call `.connect()` on it.
+- No more `Symbol` export, now `BSONSymbol` which is a deprecated BSON type


do we want to clarify the implications of BSONSymbol being a deprecated type?

Wrote some text, looks good?

maybe change the order and make one sentence?
"Existing BSON symbols in your database will be deserialized to a BSONSymbol instance; however, users should use plain strings instead of BSONSymbol"

SGTM, done!

docs/CHANGES_4.0.0.md

Co-authored-by: Daria Pardue <[email protected]>

Co-authored-by: Anna Henningsen <[email protected]>

dariakp

Resolved all comments, just the BSONSymbol wording still an open question

dariakp · 2021-07-08T18:14:03Z

docs/CHANGES_4.0.0.md

+  - Use command monitoring: `client.on('commandStarted', (ev) => {})`
+- Top-Level export no longer a function: `typeof require('mongodb') !== 'function'`
+  - Must construct a MongoClient and call `.connect()` on it.
+- No more `Symbol` export, now `BSONSymbol` which is a deprecated BSON type


maybe change the order and make one sentence?
"Existing BSON symbols in your database will be deserialized to a BSONSymbol instance; however, users should use plain strings instead of BSONSymbol"

emadum · 2021-07-08T18:21:32Z

moved the versioned api feature mention out of this file, I'm thinking we should break out features from changes, thoughts?

SGTM, there is also now a page in the official driver docs describing the feature, we don't need to duplicate that info here.

…wording

docs/CHANGES_4.0.0.md

Co-authored-by: Eric Adum <[email protected]>

docs/CHANGES_4.0.0.md

Co-authored-by: Eric Adum <[email protected]>

emadum

Probably the final round of feedback 🚀

docs/CHANGES_4.0.0.md

Co-authored-by: Eric Adum <[email protected]>

emadum

LGTM 🎉

dariakp

LGTM

docs/CHANGES_4.0.0.md

Co-authored-by: Eric Adum <[email protected]> Co-authored-by: Daria Pardue <[email protected]> Co-authored-by: Anna Henningsen <[email protected]>

nbbeeken changed the title ~~NODE-2329/upgrade-guide~~ docs(NODE-2329): write upgrade and migration guide Jul 7, 2021

docs(NODE-2329): write upgrade and migration guide

ebbd33a

nbbeeken force-pushed the NODE-2329/upgrade-guide branch from f39b752 to ebbd33a Compare July 7, 2021 20:03

nbbeeken requested review from dariakp, durran and emadum July 7, 2021 20:11

emadum suggested changes Jul 7, 2021

View reviewed changes

docs/CHANGES_4.0.0.md Outdated Show resolved Hide resolved

docs/CHANGES_4.0.0.md Outdated Show resolved Hide resolved

docs/CHANGES_4.0.0.md Outdated Show resolved Hide resolved

docs/CHANGES_4.0.0.md Outdated Show resolved Hide resolved

nbbeeken and others added 4 commits July 7, 2021 17:29

Update prose on db.createCollection

d303724

Co-authored-by: Eric Adum <[email protected]>

make more clear -> clarify

ef66c2f

Co-authored-by: Eric Adum <[email protected]>

downloadStream -> download stream

e230b9e

Co-authored-by: Eric Adum <[email protected]>

fix: make cursor classes a list

bd4199b

nbbeeken requested a review from emadum July 7, 2021 21:33

dariakp requested changes Jul 8, 2021

View reviewed changes

addaleax reviewed Jul 8, 2021

View reviewed changes

docs/CHANGES_4.0.0.md Outdated Show resolved Hide resolved

docs/CHANGES_4.0.0.md Outdated Show resolved Hide resolved

docs/CHANGES_4.0.0.md Outdated Show resolved Hide resolved

docs/CHANGES_4.0.0.md Outdated Show resolved Hide resolved

nbbeeken and others added 7 commits July 8, 2021 11:47

collections -> collection's

7a12ef3

Co-authored-by: Daria Pardue <[email protected]>

delete it being

b79075f

Co-authored-by: Daria Pardue <[email protected]>

are -> is only

d09acd8

Co-authored-by: Daria Pardue <[email protected]>

NodeJS -> Node.js

1e19087

Co-authored-by: Anna Henningsen <[email protected]>

NodeJS -> the Node.js

1240073

Co-authored-by: Anna Henningsen <[email protected]>

nodejs -> Node.js

0e65cac

Co-authored-by: Anna Henningsen <[email protected]>

fix: comments in deprecated section and run prettier

f285784

nbbeeken requested a review from dariakp July 8, 2021 15:59

wip: added feature list

38011b6

dariakp requested changes Jul 8, 2021

View reviewed changes

docs: updated feature list and added removals list, fixed bsonsymbol …

6c2c51d

…wording

emadum suggested changes Jul 9, 2021

View reviewed changes

docs/CHANGES_4.0.0.md Outdated Show resolved Hide resolved

docs/CHANGES_4.0.0.md Outdated Show resolved Hide resolved

terakilobyte mentioned this pull request Jul 9, 2021

Docsp 17292 mongodb/docs-node#206

Merged

6 tasks

nbbeeken and others added 2 commits July 9, 2021 12:25

Preserve old behavior in listCollections snippet

18a69c8

Co-authored-by: Eric Adum <[email protected]>

Clarify strict option text

20e948c

Co-authored-by: Eric Adum <[email protected]>

nbbeeken and others added 6 commits July 9, 2021 13:23

Remove Dupe

de7b6e5

Co-authored-by: Eric Adum <[email protected]>

fix monospace

84437a5

Co-authored-by: Eric Adum <[email protected]>

fix monospace

5e03592

Co-authored-by: Eric Adum <[email protected]>

Trademark styling

d4c3df7

Co-authored-by: Eric Adum <[email protected]>

Mention Node.js support of 3.x

62ba1d7

Co-authored-by: Eric Adum <[email protected]>

add note about NODE-1797

e205ea5

nbbeeken requested a review from emadum July 9, 2021 18:18

emadum suggested changes Jul 9, 2021

View reviewed changes

docs/CHANGES_4.0.0.md Outdated Show resolved Hide resolved

docs/CHANGES_4.0.0.md Show resolved Hide resolved

docs/CHANGES_4.0.0.md Outdated Show resolved Hide resolved

nbbeeken and others added 2 commits July 9, 2021 15:42

Clarify change stream unique type usage error

4e1497d

Co-authored-by: Eric Adum <[email protected]>

fix GIRDstore spelling 🤦

532191f

Co-authored-by: Eric Adum <[email protected]>

nbbeeken requested a review from emadum July 9, 2021 19:43

emadum suggested changes Jul 12, 2021

View reviewed changes

docs/CHANGES_4.0.0.md Outdated Show resolved Hide resolved

docs/CHANGES_4.0.0.md Show resolved Hide resolved

docs/CHANGES_4.0.0.md Outdated Show resolved Hide resolved

docs/CHANGES_4.0.0.md Outdated Show resolved Hide resolved

nbbeeken and others added 4 commits July 12, 2021 13:54

you -> your

51b57aa

Co-authored-by: Eric Adum <[email protected]>

Note on transformStream removal

6c254ea

Co-authored-by: Eric Adum <[email protected]>

monospace SERVICE_NAME

01c7c7b

Co-authored-by: Eric Adum <[email protected]>

Capitalization

d5cf59d

Co-authored-by: Eric Adum <[email protected]>

nbbeeken requested a review from emadum July 12, 2021 17:55

emadum approved these changes Jul 12, 2021

View reviewed changes

nbbeeken added 4 commits July 12, 2021 17:23

fix: update links on readme and add md5 notes

3ec4e7f

add snapshot feature to list

b54be0c

rename feature file

240f1f3

capitalize T

8f9594e

dariakp approved these changes Jul 13, 2021

View reviewed changes

dariakp reviewed Jul 13, 2021

View reviewed changes

docs/CHANGES_4.0.0.md Outdated Show resolved Hide resolved

fix: comma and casing

f45406b

nbbeeken requested a review from emadum July 13, 2021 16:38

emadum approved these changes Jul 13, 2021

View reviewed changes

nbbeeken merged commit a3aa060 into 4.0 Jul 13, 2021

nbbeeken deleted the NODE-2329/upgrade-guide branch July 13, 2021 17:12

ljhaywar pushed a commit that referenced this pull request Nov 9, 2021

docs(NODE-2329): write upgrade and migration guide (#2890)

66e9e55

Co-authored-by: Eric Adum <[email protected]> Co-authored-by: Daria Pardue <[email protected]> Co-authored-by: Anna Henningsen <[email protected]>

docs(NODE-2329): write upgrade and migration guide #2890

docs(NODE-2329): write upgrade and migration guide #2890

Uh oh!

Conversation

nbbeeken commented Jul 7, 2021

Uh oh!

emadum left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dariakp Jul 8, 2021

Choose a reason for hiding this comment

Uh oh!

nbbeeken Jul 8, 2021

Choose a reason for hiding this comment

Uh oh!

dariakp Jul 8, 2021 • 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!

nbbeeken Jul 9, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dariakp left a comment

Choose a reason for hiding this comment

Uh oh!

dariakp Jul 8, 2021 • 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!

emadum commented Jul 8, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

emadum left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

emadum left a comment

Choose a reason for hiding this comment

Uh oh!

dariakp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

dariakp Jul 8, 2021 •

edited

Loading

dariakp Jul 8, 2021 •

edited

Loading