(DOCSP-21841): add release notes and compat notes template pages (#928)

jeff-allen-mongo · web-flow · commit c367d86be690 · 2022-04-06T17:33:26.000-04:00
* (DOCSP-21841): add release notes and compat notes template pages * update snooty.toml versions * replace rapid include with in-dev include * add missing upgrade ref
diff --git a/snooty.toml b/snooty.toml
@@ -207,13 +207,13 @@ year = "2022"
 
 [constants]
 package-branch = "testing" # testing for dev rc releases
-windows-dir-version = "5.0" # wizard
+windows-dir-version = "6.0" # wizard
 package-name-org = "mongodb-org"
 package-name-enterprise = "mongodb-enterprise"
-version = "5.3"
-latest-lts-version = "5.0"
-release = "5.0.6"
-version-dev = "5.3"
+version = "6.0"
+latest-lts-version = "6.0"
+release = "6.0.0"
+version-dev = "6.0"
 pgp-version = "{+version+}"
 rsa-key = "4B7C549A058F8B6B"
 pgp-fingerprint = "E162F504A20CDF15827F718D4B7C549A058F8B6B"
@@ -259,4 +259,3 @@ section = 1
 file = "reference/parameters.txt"
 title = "MongoDB setParameter Options"
 section = 5
-
diff --git a/source/administration/install-community.txt b/source/administration/install-community.txt
@@ -10,7 +10,7 @@ Install MongoDB Community Edition
    :depth: 1
    :class: singlecol
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
 
 These documents provide instructions to install MongoDB Community Edition.
 
diff --git a/source/administration/install-on-linux.txt b/source/administration/install-on-linux.txt
@@ -4,7 +4,7 @@ Install MongoDB Community Edition on Linux
 
 .. default-domain:: mongodb
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
 
 These documents provide instructions to install MongoDB Community
 Edition for supported Linux systems.
diff --git a/source/administration/upgrade-community-to-enterprise.txt b/source/administration/upgrade-community-to-enterprise.txt
@@ -10,7 +10,7 @@ Upgrade MongoDB Community to MongoDB Enterprise
    :depth: 1
    :class: singlecol
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
 
 .. include:: /includes/extracts/enterprise-additional-features.rst
 
diff --git a/source/includes/fact-mongodb-intro.rst b/source/includes/fact-mongodb-intro.rst
@@ -8,4 +8,4 @@ The manual describes key concepts in MongoDB such as:
 - Operational and administrative references
 - Tutorials and procedures
 
-.. include:: /includes/rapid-release-short.rst
+.. include:: /includes/in-dev.rst-short.rst
diff --git a/source/installation.txt b/source/installation.txt
@@ -29,7 +29,7 @@ Install MongoDB
 
 .. include:: /includes/unicode-checkmark.rst
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
 
 MongoDB is available in two server editions: *Community* and
 *Enterprise*.
@@ -92,7 +92,7 @@ platforms, for both the Community Edition and the
 Upgrade Community Edition to Enterprise Edition Tutorials
 ---------------------------------------------------------
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
 
 .. _mongodb-supported-platforms:
 
diff --git a/source/reference/installation-ubuntu-community-troubleshooting.txt b/source/reference/installation-ubuntu-community-troubleshooting.txt
@@ -15,4 +15,4 @@ Troubleshooting
 .. |arrow| unicode:: U+27A4
 .. |distro-name| replace:: Ubuntu
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
diff --git a/source/release-notes.txt b/source/release-notes.txt
@@ -9,57 +9,23 @@ Always install the latest, stable version of MongoDB. See
 See the following release notes for an account of the changes in major
 versions. Release notes also include instructions for upgrade.
 
-Atlas Rapid Releases
-~~~~~~~~~~~~~~~~~~~~
-
-.. important::
-
-   Rapid releases are only supported for MongoDB Atlas. Rapid releases
-   are not supported for use on-premises. For more information, see
-   :ref:`release-version-numbers`.
-
-Current Atlas Rapid Release
-```````````````````````````
-
-(*5.3-series*)
-
-:ref:`release-notes-5.3`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden:
-
-   /release-notes/5.3
-
-Previous Atlas Rapid Releases
-`````````````````````````````
-
-- :ref:`5.2-series <release-notes-5.2>`
-- :ref:`5.1- series <release-notes-5.1>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden:
-
-   /release-notes/5.2
-   /release-notes/5.1
-
 Current Stable Release
 ~~~~~~~~~~~~~~~~~~~~~~
 
-(*5.0-series*)
+(*6.0-series*)
 
-:doc:`/release-notes/5.0`
+:doc:`/release-notes/6.0`
 
 .. toctree::
    :maxdepth: 1
    :hidden:
 
-   /release-notes/5.0
+   /release-notes/6.0
 
 Previous Stable Releases
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
+- :doc:`/release-notes/5.0`
 - :doc:`/release-notes/4.4`
 - :doc:`/release-notes/4.2`
 - :doc:`/release-notes/4.0`
diff --git a/source/release-notes/6.0-compatibility.txt b/source/release-notes/6.0-compatibility.txt
@@ -0,0 +1,16 @@
+====================================
+Compatibility Changes in MongoDB 6.0
+====================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+.. include:: /includes/in-dev.rst
+
+The following 6.0 changes can affect compatibility with older
+versions of MongoDB.
diff --git a/source/release-notes/6.0.txt b/source/release-notes/6.0.txt
@@ -0,0 +1,24 @@
+=============================
+Release Notes for MongoDB 6.0
+=============================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: twocols
+
+.. include:: /includes/in-dev.rst
+
+.. toctree::
+   :titlesonly:
+   :hidden:
+
+   /release-notes/6.0-compatibility
+
+.. _6.0-upgrade:
+
+Upgrade Procedures
+------------------
diff --git a/source/tutorial/install-mongodb-enterprise-on-amazon-tarball.txt b/source/tutorial/install-mongodb-enterprise-on-amazon-tarball.txt
@@ -18,4 +18,4 @@ Install MongoDB Enterprise on Amazon Linux using .tgz Tarball
 .. |executable-name| replace:: ``mongod``
 .. |mdb-download-link| replace:: `MongoDB Download Center <https://www.mongodb.com/try/download/enterprise?tck=docs_server>`__
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
diff --git a/source/tutorial/install-mongodb-enterprise-on-amazon.txt b/source/tutorial/install-mongodb-enterprise-on-amazon.txt
@@ -17,7 +17,7 @@ Install MongoDB Enterprise Edition on Amazon Linux
 .. |package-manager| replace:: ``yum``
 .. |executable-name| replace:: ``mongod``
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
 
 .. toctree::
    :titlesonly:
diff --git a/source/tutorial/install-mongodb-enterprise-on-debian-tarball.txt b/source/tutorial/install-mongodb-enterprise-on-debian-tarball.txt
@@ -18,4 +18,4 @@ Install MongoDB Enterprise on Debian using .tgz Tarball
 .. |executable-name| replace:: ``mongod``
 .. |mdb-download-link| replace:: `MongoDB Download Center <https://www.mongodb.com/try/download/enterprise?tck=docs_server>`__
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
diff --git a/source/tutorial/install-mongodb-enterprise-on-debian.txt b/source/tutorial/install-mongodb-enterprise-on-debian.txt
@@ -17,7 +17,7 @@ Install MongoDB Enterprise Edition on Debian
 .. |package-manager| replace:: ``apt``
 .. |executable-name| replace:: ``mongod``
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
 
 .. toctree::
    :hidden:
diff --git a/source/tutorial/install-mongodb-enterprise-on-os-x.txt b/source/tutorial/install-mongodb-enterprise-on-os-x.txt
@@ -17,4 +17,4 @@ Install MongoDB Enterprise on macOS
 .. |executable-name| replace:: ``mongod``
 .. |mdb-download-link| replace:: `MongoDB Download Center <https://www.mongodb.com/try/download/enterprise?tck=docs_server>`__
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
diff --git a/source/tutorial/install-mongodb-enterprise-on-red-hat-tarball.txt b/source/tutorial/install-mongodb-enterprise-on-red-hat-tarball.txt
@@ -18,4 +18,4 @@ Install MongoDB Enterprise on Red Hat or CentOS using .tgz Tarball
 .. |executable-name| replace:: ``mongod``
 .. |mdb-download-link| replace:: `MongoDB Download Center <https://www.mongodb.com/try/download/enterprise?tck=docs_server>`__
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
diff --git a/source/tutorial/install-mongodb-enterprise-on-red-hat.txt b/source/tutorial/install-mongodb-enterprise-on-red-hat.txt
@@ -17,7 +17,7 @@ Install MongoDB Enterprise Edition on Red Hat or CentOS
 .. |package-manager| replace:: ``yum``
 .. |executable-name| replace:: ``mongod``
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
 
 .. toctree::
    :hidden:
diff --git a/source/tutorial/install-mongodb-enterprise-on-suse-tarball.txt b/source/tutorial/install-mongodb-enterprise-on-suse-tarball.txt
@@ -18,4 +18,4 @@ Install MongoDB Enterprise on SUSE using .tgz Tarball
 .. |executable-name| replace:: ``mongod``
 .. |mdb-download-link| replace:: `MongoDB Download Center <https://www.mongodb.com/try/download/enterprise?tck=docs_server>`__
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
diff --git a/source/tutorial/install-mongodb-enterprise-on-suse.txt b/source/tutorial/install-mongodb-enterprise-on-suse.txt
@@ -17,7 +17,7 @@ Install MongoDB Enterprise Edition on SUSE
 .. |package-manager| replace:: ``zypper``
 .. |executable-name| replace:: ``mongod``
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
 
 .. toctree::
    :hidden:
diff --git a/source/tutorial/install-mongodb-enterprise-on-ubuntu-tarball.txt b/source/tutorial/install-mongodb-enterprise-on-ubuntu-tarball.txt
@@ -20,4 +20,4 @@ Install MongoDB Enterprise on Ubuntu using .tgz Tarball
 .. |executable-name| replace:: ``mongod``
 .. |mdb-download-link| replace:: `MongoDB Download Center <https://www.mongodb.com/try/download/enterprise?tck=docs_server>`__
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
diff --git a/source/tutorial/install-mongodb-enterprise-on-ubuntu.txt b/source/tutorial/install-mongodb-enterprise-on-ubuntu.txt
@@ -19,7 +19,7 @@ Install MongoDB Enterprise Edition on Ubuntu
 .. |package-manager| replace:: ``apt``
 .. |executable-name| replace:: ``mongod``
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
 
 .. toctree::
    :hidden:
diff --git a/source/tutorial/install-mongodb-enterprise-on-windows-unattended.txt b/source/tutorial/install-mongodb-enterprise-on-windows-unattended.txt
@@ -16,4 +16,4 @@ Install MongoDB Enterprise on Windows using ``msiexec.exe``
 .. |executable-name| replace:: ``mongod.exe``
 .. |mdb-download-link| replace:: `MongoDB Download Center <https://www.mongodb.com/try/download/enterprise?tck=docs_server>`__
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
diff --git a/source/tutorial/install-mongodb-enterprise-on-windows.txt b/source/tutorial/install-mongodb-enterprise-on-windows.txt
@@ -17,7 +17,7 @@ Install MongoDB Enterprise Edition on Windows
 .. |executable-name| replace:: ``mongod.exe``
 .. |mdb-download-link| replace:: `MongoDB Download Center <https://www.mongodb.com/try/download/enterprise?tck=docs_server>`__
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
 
 .. toctree::
    :hidden:
diff --git a/source/tutorial/install-mongodb-enterprise-with-docker.txt b/source/tutorial/install-mongodb-enterprise-with-docker.txt
@@ -6,4 +6,4 @@ Install MongoDB Enterprise with Docker
 
 .. _`MongoDB Download Center`: https://www.mongodb.com/try/download/enterprise?tck=docs_server
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
diff --git a/source/tutorial/install-mongodb-on-amazon-tarball.txt b/source/tutorial/install-mongodb-on-amazon-tarball.txt
@@ -20,4 +20,4 @@ Install MongoDB Community on Amazon Linux using .tgz Tarball
 .. |executable-name| replace:: ``mongod``
 .. |mdb-download-link| replace:: `MongoDB Download Center <https://www.mongodb.com/try/download/community?tck=docs_server>`__
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
diff --git a/source/tutorial/install-mongodb-on-amazon.txt b/source/tutorial/install-mongodb-on-amazon.txt
@@ -17,7 +17,7 @@ Install MongoDB Community Edition on Amazon Linux
 .. |package-manager| replace:: ``yum``
 .. |executable-name| replace:: ``mongod``
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
 
 .. toctree::
    :hidden:
diff --git a/source/tutorial/install-mongodb-on-debian-tarball.txt b/source/tutorial/install-mongodb-on-debian-tarball.txt
@@ -18,4 +18,4 @@ Install MongoDB Community on Debian using .tgz Tarball
 .. |executable-name| replace:: ``mongod``
 .. |mdb-download-link| replace:: `MongoDB Download Center <https://www.mongodb.com/try/download/community?tck=docs_server>`__
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
diff --git a/source/tutorial/install-mongodb-on-debian.txt b/source/tutorial/install-mongodb-on-debian.txt
@@ -17,7 +17,7 @@ Install MongoDB Community Edition on Debian
 .. |package-manager| replace:: ``apt``
 .. |executable-name| replace:: ``mongod``
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
 
 .. toctree::
    :hidden:
diff --git a/source/tutorial/install-mongodb-on-os-x-tarball.txt b/source/tutorial/install-mongodb-on-os-x-tarball.txt
@@ -17,4 +17,4 @@ Install MongoDB Community on macOS using ``.tgz`` Tarball
 .. |executable-name| replace:: ``mongod``
 .. |mdb-download-link| replace:: `MongoDB Download Center <https://www.mongodb.com/try/download/community?tck=docs_server>`__
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
diff --git a/source/tutorial/install-mongodb-on-os-x.txt b/source/tutorial/install-mongodb-on-os-x.txt
@@ -16,7 +16,7 @@ Install MongoDB Community Edition on macOS
 .. |package-manager| replace:: ``brew``
 .. |executable-name| replace:: ``mongod``
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
 
 .. toctree::
    :hidden:
diff --git a/source/tutorial/install-mongodb-on-red-hat-tarball.txt b/source/tutorial/install-mongodb-on-red-hat-tarball.txt
@@ -18,4 +18,4 @@ Install MongoDB Community on Red Hat or CentOS using .tgz Tarball
 .. |executable-name| replace:: ``mongod``
 .. |mdb-download-link| replace:: `MongoDB Download Center <https://www.mongodb.com/try/download/community?tck=docs_server>`__
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
diff --git a/source/tutorial/install-mongodb-on-red-hat.txt b/source/tutorial/install-mongodb-on-red-hat.txt
@@ -17,7 +17,7 @@ Install MongoDB Community Edition on Red Hat or CentOS
 .. |package-manager| replace:: ``yum``
 .. |executable-name| replace:: ``mongod``
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
 
 .. toctree::
    :hidden:
diff --git a/source/tutorial/install-mongodb-on-suse-tarball.txt b/source/tutorial/install-mongodb-on-suse-tarball.txt
@@ -18,4 +18,4 @@ Install MongoDB Community on SUSE using .tgz Tarball
 .. |executable-name| replace:: ``mongod``
 .. |mdb-download-link| replace:: `MongoDB Download Center <https://www.mongodb.com/try/download/community?tck=docs_server>`__
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
diff --git a/source/tutorial/install-mongodb-on-suse.txt b/source/tutorial/install-mongodb-on-suse.txt
@@ -17,7 +17,7 @@ Install MongoDB Community Edition on SUSE
 .. |package-manager| replace:: ``zypper``
 .. |executable-name| replace:: ``mongod``
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
 
 .. toctree::
    :hidden:
diff --git a/source/tutorial/install-mongodb-on-ubuntu-tarball.txt b/source/tutorial/install-mongodb-on-ubuntu-tarball.txt
@@ -20,4 +20,4 @@ Install MongoDB Community on Ubuntu using .tgz Tarball
 .. |executable-name| replace:: ``mongod``
 .. |mdb-download-link| replace:: `MongoDB Download Center <https://www.mongodb.com/try/download/community?tck=docs_server>`__
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
diff --git a/source/tutorial/install-mongodb-on-ubuntu.txt b/source/tutorial/install-mongodb-on-ubuntu.txt
@@ -19,7 +19,7 @@ Install MongoDB Community Edition on Ubuntu
 .. |package-manager| replace:: ``apt``
 .. |executable-name| replace:: ``mongod``
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
 
 .. toctree::
    :hidden:
diff --git a/source/tutorial/install-mongodb-on-windows-unattended.txt b/source/tutorial/install-mongodb-on-windows-unattended.txt
@@ -16,4 +16,4 @@ Install MongoDB Community on Windows using ``msiexec.exe``
 .. |executable-name| replace:: ``mongod.exe``
 .. |mdb-download-link| replace:: `MongoDB Download Center <https://www.mongodb.com/try/download/community?tck=docs_server>`__
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
diff --git a/source/tutorial/install-mongodb-on-windows.txt b/source/tutorial/install-mongodb-on-windows.txt
@@ -16,7 +16,7 @@ Install MongoDB Community Edition on Windows
 .. |executable-name| replace:: ``mongod.exe``
 .. |mdb-download-link| replace:: `MongoDB Download Center <https://www.mongodb.com/try/download/community?tck=docs_server>`__
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
 
 .. toctree::
    :hidden:
diff --git a/source/tutorial/upgrade-to-enterprise-replica-set.txt b/source/tutorial/upgrade-to-enterprise-replica-set.txt
@@ -12,4 +12,4 @@ Upgrade to MongoDB Enterprise (Replica Set)
 
 .. include:: /includes/extracts/enterprise-additional-features.rst
 
-.. include:: /includes/rapid-release.rst
+.. include:: /includes/in-dev.rst
diff --git a/source/tutorial/upgrade-to-enterprise-sharded-cluster.txt b/source/tutorial/upgrade-to-enterprise-sharded-cluster.txt
diff --git a/source/tutorial/upgrade-to-enterprise-standalone.txt b/source/tutorial/upgrade-to-enterprise-standalone.txt
diff --git a/source/tutorial/verify-mongodb-packages.txt b/source/tutorial/verify-mongodb-packages.txt
