Skip to content

Commit

Permalink
DOCPS-31571: Add upgrade information (#779)
Browse files Browse the repository at this point in the history
* DOCPS-31571: Add upgrade information

* small changes

* wording

* feedback fixes

* vale fix

* adding clarifying info

(cherry picked from commit 31ac73b)
  • Loading branch information
norareidy committed Sep 13, 2023
1 parent dde4fe9 commit 1f38b7d
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions source/upgrade.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,12 @@ Upgrade Driver Versions
Overview
--------

On this page, you can learn about any changes you might need to make to
your application to upgrade your driver to a new version without loss of
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 losing functionality, if applicable.

How to Upgrade
--------------

Before you upgrade, perform the following actions:

Expand All @@ -35,6 +38,18 @@ Before you upgrade, perform the following actions:
application when upgrading driver versions by using the
:ref:`{+stable-api+} <nodejs-stable-api>`.

To upgrade your driver version, run the following command in your application's
directory:

.. code-block:: bash

npm install mongodb@{+version+}

To upgrade to a different version of the driver, replace the information after the
``@`` symbol with your preferred version number. For more information about the
``npm install`` command, see the `npm-install <https://docs.npmjs.com/cli/v10/commands/npm-install?v=true>`__
npm documentation.

.. _node-breaking-changes:

Breaking Changes
Expand Down

0 comments on commit 1f38b7d

Please sign in to comment.