(DOCSP-39188): Clarify that restores can be at most one major version ahead (#150)

jeff-allen-mongo · web-flow · commit 23e6e6c62f6b · 2024-05-08T15:54:01.000-04:00
* (DOCSP-39188): Clarify that upgrades must be to one major version ahead * try new webhook * try new webhook * try new webhook * fix include * fix include version * edits * add version info to top-level dump and restore pages * wording * address review feedback * remove unneeded variable * review feedback
diff --git a/snooty.toml b/snooty.toml
@@ -26,6 +26,7 @@ qe = "Queryable Encryption"
 version = "100.9.0"
 release = "{+version+}"
 pgp-version = "{+version+}"
+server-version = "7.0"
 pgp-fingerprint = "E162F504A20CDF15827F718D4B7C549A058F8B6B"
 rsa-key = "4B7C549A058F8B6B"
 pgp-fingerprint-fmt = "E162 F504 A20C DF15 827F  718D 4B7C 549A 058F 8B6B"
diff --git a/source/includes/fact-match-dump-restore-versions.rst b/source/includes/fact-match-dump-restore-versions.rst
@@ -14,9 +14,12 @@ To change your feature compatibility version, see
 
 .. note::
 
-   You can restore the BSON files generated from ``mongodump``
-   into MongoDB deployments running the same or newer version 
-   as the source deployment.
+   You can restore the BSON files generated from ``mongodump`` into
+   MongoDB deployments running the same or newer version as the source
+   deployment. However, restoring files into a newer version deployment
+   is not the recommended way to upgrade your deployment. To learn how to
+   upgrade your deployment, see the :manual:`upgrade documentation
+   </release-notes/{+server-version+}-upgrade>`.
 
    This guarantee does not apply to metadata, archive, or oplog replay 
    files. If you try to restore these files using different 
diff --git a/source/includes/mongodump-restore-version-link.rst b/source/includes/mongodump-restore-version-link.rst
@@ -0,0 +1,6 @@
+You can restore the BSON files generated from ``mongodump`` into MongoDB
+deployments running the same or newer version as the source deployment.
+However, restoring files into a newer version deployment is not the
+recommended way to upgrade your deployment. To learn how to upgrade your
+deployment, see the :manual:`upgrade documentation
+</release-notes/{+server-version+}-upgrade>`.
diff --git a/source/mongodump.txt b/source/mongodump.txt
@@ -48,6 +48,8 @@ a database's contents. ``mongodump`` can export data from:
 ``mongodump`` can connect to :binary:`~bin.mongod` and
 :binary:`~bin.mongos` instances.
 
+.. include:: /includes/mongodump-restore-version-link.rst
+
 Run ``mongodump`` from the system command line, not the
 :binary:`~bin.mongo` shell.
 
diff --git a/source/mongodump/mongodump-behavior.txt b/source/mongodump/mongodump-behavior.txt
@@ -44,6 +44,8 @@ to authenticate your ``mongodump`` session and to indicate the database
 being dumped. For an example of using a different database for
 authentication when using ``mongodump``, see :ref:`mongodump-auth-dump`.
 
+.. _mongodump-matching-server-version:
+
 Restore to Matching Server Version
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
diff --git a/source/mongorestore.txt b/source/mongorestore.txt
@@ -37,6 +37,8 @@ The ``mongorestore`` program loads data from either a binary
 database dump created by :binary:`~bin.mongodump` or the standard input
 into a :binary:`~bin.mongod` or :binary:`~bin.mongos` instance.
 
+.. include:: /includes/mongodump-restore-version-link.rst
+
 Run ``mongorestore`` from the system command line, not the
 :binary:`~bin.mongo` shell.
 
@@ -864,4 +866,4 @@ Learn More
 
    Compatibility and Installation </mongorestore/mongorestore-compatibility-and-installation>
    Behavior </mongorestore/mongorestore-behavior-access-usage>
-   Examples </mongorestore/mongorestore-examples>
+   Examples </mongorestore/mongorestore-examples>
