From 1f38b7d08d209b937dd5a9a55c24c99a1d4a5ea1 Mon Sep 17 00:00:00 2001 From: Nora Reidy Date: Wed, 13 Sep 2023 14:03:45 -0400 Subject: [PATCH] DOCPS-31571: Add upgrade information (#779) * DOCPS-31571: Add upgrade information * small changes * wording * feedback fixes * vale fix * adding clarifying info (cherry picked from commit 31ac73b09afe56675a7aff103e936bbfac0acc15) --- source/upgrade.txt | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/source/upgrade.txt b/source/upgrade.txt index fe505f962..70e45c2cc 100644 --- a/source/upgrade.txt +++ b/source/upgrade.txt @@ -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: @@ -35,6 +38,18 @@ Before you upgrade, perform the following actions: application when upgrading driver versions by using the :ref:`{+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 `__ +npm documentation. + .. _node-breaking-changes: Breaking Changes