DOCPS-31571: Add upgrade information #779
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ccho-mongodb
suggested changes
Sep 6, 2023
ccho-mongodb
approved these changes
Sep 12, 2023
source/upgrade.txt
Outdated
|
|
||
| npm install mongodb@{+version+} | ||
|
|
||
| To upgrade to a different version of the driver, replace ``{+version+}`` with |
There was a problem hiding this comment.
Suggestion:
Rather than depending on the user to identify a specific "version", I think it could be easier to follow by explaining the placement of the information.
E.g.
To upgrade to a different version of the driver, replace the information after the "@" symbol with your preferred version number.
It could also be helpful to link to the official npm documentation as well. E.g.
To learn more about the npm install command, see the `npm-install <https://docs.npmjs.com/cli/v10/commands/npm-install?v=true>`__ npm documentation.
source/upgrade.txt
Outdated
| functionality. | ||
| On this page, you can learn how to upgrade your driver to a new version. This page also | ||
| includes the changes you must make to your application to upgrade your driver | ||
| without a loss of functionality, if applicable. |
There was a problem hiding this comment.
Suggestion:
I think "a loss of functionality" doesn't identify what loses the functionality as well as the following phrase:
Suggested change
| without a loss of functionality, if applicable. | |
| without losing functionality, if applicable. |
Implied in this statement is "without your application losing functionality" whereas the current version doesn't imply that relationship.
norareidy
added a commit
that referenced
this pull request
Sep 13, 2023
* DOCPS-31571: Add upgrade information * small changes * wording * feedback fixes * vale fix * adding clarifying info (cherry picked from commit 31ac73b)
norareidy
added a commit
that referenced
this pull request
Sep 13, 2023
* DOCPS-31571: Add upgrade information * small changes * wording * feedback fixes * vale fix * adding clarifying info (cherry picked from commit 31ac73b)
norareidy
added a commit
that referenced
this pull request
Sep 13, 2023
* DOCPS-31571: Add upgrade information * small changes * wording * feedback fixes * vale fix * adding clarifying info (cherry picked from commit 31ac73b)
norareidy
added a commit
that referenced
this pull request
Sep 13, 2023
* DOCPS-31571: Add upgrade information * small changes * wording * feedback fixes * vale fix * adding clarifying info (cherry picked from commit 31ac73b)
norareidy
added a commit
that referenced
this pull request
Sep 13, 2023
* DOCPS-31571: Add upgrade information * small changes * wording * feedback fixes * vale fix * adding clarifying info (cherry picked from commit 31ac73b)
norareidy
added a commit
that referenced
this pull request
Sep 13, 2023
* DOCPS-31571: Add upgrade information * small changes * wording * feedback fixes * vale fix * adding clarifying info (cherry picked from commit 31ac73b)
norareidy
added a commit
that referenced
this pull request
Sep 13, 2023
* DOCPS-31571: Add upgrade information * small changes * wording * feedback fixes * vale fix * adding clarifying info (cherry picked from commit 31ac73b)
norareidy
added a commit
that referenced
this pull request
Sep 13, 2023
* DOCPS-31571: Add upgrade information * small changes * wording * feedback fixes * vale fix * adding clarifying info (cherry picked from commit 31ac73b)
norareidy
added a commit
that referenced
this pull request
Sep 13, 2023
* DOCPS-31571: Add upgrade information * small changes * wording * feedback fixes * vale fix * adding clarifying info (cherry picked from commit 31ac73b)
norareidy
added a commit
that referenced
this pull request
Sep 13, 2023
* DOCPS-31571: Add upgrade information * small changes * wording * feedback fixes * vale fix * adding clarifying info (cherry picked from commit 31ac73b)
norareidy
added a commit
that referenced
this pull request
Sep 13, 2023
* DOCPS-31571: Add upgrade information * small changes * wording * feedback fixes * vale fix * adding clarifying info (cherry picked from commit 31ac73b)
norareidy
added a commit
that referenced
this pull request
Sep 13, 2023
* DOCPS-31571: Add upgrade information * small changes * wording * feedback fixes * vale fix * adding clarifying info (cherry picked from commit 31ac73b)
norareidy
added a commit
that referenced
this pull request
Sep 13, 2023
* DOCPS-31571: Add upgrade information * small changes * wording * feedback fixes * vale fix * adding clarifying info (cherry picked from commit 31ac73b)
norareidy
added a commit
that referenced
this pull request
Sep 13, 2023
* DOCPS-31571: Add upgrade information * small changes * wording * feedback fixes * vale fix * adding clarifying info (cherry picked from commit 31ac73b)
norareidy
added a commit
that referenced
this pull request
Sep 13, 2023
* DOCPS-31571: Add upgrade information * small changes * wording * feedback fixes * vale fix * adding clarifying info (cherry picked from commit 31ac73b)
norareidy
added a commit
that referenced
this pull request
Sep 13, 2023
* DOCPS-31571: Add upgrade information * small changes * wording * feedback fixes * vale fix * adding clarifying info (cherry picked from commit 31ac73b)
norareidy
added a commit
that referenced
this pull request
Sep 13, 2023
* DOCPS-31571: Add upgrade information * small changes * wording * feedback fixes * vale fix * adding clarifying info (cherry picked from commit 31ac73b)
norareidy
added a commit
that referenced
this pull request
Sep 13, 2023
* DOCPS-31571: Add upgrade information * small changes * wording * feedback fixes * vale fix * adding clarifying info (cherry picked from commit 31ac73b)
norareidy
added a commit
that referenced
this pull request
Sep 13, 2023
* DOCPS-31571: Add upgrade information * small changes * wording * feedback fixes * vale fix * adding clarifying info (cherry picked from commit 31ac73b)
norareidy
added a commit
that referenced
this pull request
Sep 13, 2023
* DOCPS-31571: Add upgrade information * small changes * wording * feedback fixes * vale fix * adding clarifying info (cherry picked from commit 31ac73b)
mongoKart
pushed a commit
to mongoKart/docs-node
that referenced
this pull request
Nov 3, 2023
* DOCPS-31571: Add upgrade information * small changes * wording * feedback fixes * vale fix * adding clarifying info
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-31571
Staging - https://docs-mongodbcom-staging.corp.mongodb.com/node/docsworker-xlarge/DOCPS-31571-upgrade-instructions/upgrade/
Self-Review Checklist