Reduced ESR maintenance overhead with file includes (#7721)

* Reduced ESR maintenance overhead with file includes * Update source/about/common-esr-support-rst.rst Co-authored-by: Amy Blais <29708087+amyblais@users.noreply.github.com> * Update source/about/common-esr-support-upgrade.md Co-authored-by: Amy Blais <29708087+amyblais@users.noreply.github.com> * Update source/about/common-esr-support.md Co-authored-by: Amy Blais <29708087+amyblais@users.noreply.github.com> * Added note formatting * Applied build fixes --------- Co-authored-by: Amy Blais <29708087+amyblais@users.noreply.github.com>
mattermost · Feb 19, 2025 · 2f7dc89 · 2f7dc89
1 parent e0e1032
commit 2f7dc89
Show file tree

Hide file tree

Showing 17 changed files with 57 additions and 30 deletions.
diff --git a/source/about/common-esr-support-rst.rst b/source/about/common-esr-support-rst.rst
@@ -0,0 +1 @@
+Support for Mattermost Server v9.11 :ref:`Extended Support Release <about/release-policy:extended support releases>` is coming to the end of its life cycle on May 15, 2025. Upgrading to :doc:`Mattermost Server v10.5 or later </about/mattermost-server-releases>` is required.
diff --git a/source/about/common-esr-support-upgrade.md b/source/about/common-esr-support-upgrade.md
@@ -0,0 +1,4 @@
+- Support for Mattermost Server v9.11 [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) is coming to the end of its life cycle on May 15, 2025. Upgrading to Mattermost Server v10.5 or later is required.
+- Upgrading from ESR-to-ESR (``major`` -> ``major_next``) is fully supported and tested. However, upgrading from ESR-to-ESR (``major`` to ``major+2``) is supported, but not tested. If you plan to upgrade across multiple releases, we strongly recommend upgrading from an ESR to another ESR. For example, if you're upgrading from the v8.1 ESR, upgrade to the [v9.5 ESR](https://docs.mattermost.com/about/mattermost-v9-changelog.html#release-v9-5-extended-support-release) or the [v9.11 ESR](https://docs.mattermost.com/about/mattermost-v9-changelog.html#release-v9-11-extended-support-release).
+- See the [Important Upgrade Notes](https://docs.mattermost.com/upgrade/important-upgrade-notes.html) documentation for details on upgrading to a newer release.
+- See the [changelog in progress](https://bit.ly/2nK3cVf) for details about the upcoming release.
diff --git a/source/about/common-esr-support.md b/source/about/common-esr-support.md
@@ -0,0 +1 @@
+Support for Mattermost Server v9.11 [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) is coming to the end of its life cycle on May 15, 2025. Upgrading to [Mattermost Server v10.5](https://docs.mattermost.com/about/mattermost-v10-changelog.html#release-v10-5-extended-support-release) or later is required.
diff --git a/source/about/desktop-app-changelog.md b/source/about/desktop-app-changelog.md
@@ -5,6 +5,10 @@
 
 This changelog summarizes updates to Mattermost desktop app releases for [Mattermost](https://mattermost.com).
 
+```{Important}
+```{include} common-esr-support.md
+```
+
 (release-v5-11)=
 ## Release v5.11 (Extended Support Release)
 

diff --git a/source/about/mattermost-desktop-releases.md b/source/about/mattermost-desktop-releases.md
@@ -4,7 +4,7 @@
 ```
 
 ```{Important}
- Support for Mattermost Server v9.11 [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) is coming to the end of its life cycle on May 15, 2025. Upgrading to Mattermost Server v10.5 or later is recommended.
+```{include} common-esr-support.md
 ```
 
 ## Frequency

diff --git a/source/about/mattermost-mobile-releases.md b/source/about/mattermost-mobile-releases.md
@@ -4,8 +4,7 @@
 ```
 
 ```{Important}
-- Support for Mattermost Server v9.11 [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) is coming to the end of its life cycle on May 15, 2025. Upgrading to Mattermost Server v10.5 or later is recommended.
-- We strongly recommend using the latest mobile app release available that contains the latest security fixes and user experience enhancements. Mobile app releases are tested against all generally available Mattermost server and extended support releases.
+```{include} common-esr-support.md
 ```
 
 ## Frequency
@@ -14,6 +13,10 @@ Mattermost releases a new mobile app version every month. Mattermost tests the l
 
 See the [Mobile app changelog](/about/mobile-app-changelog) for release details, and see the [iOS mobile app](/collaborate/install-ios-app) and the [Android mobile app](/collaborate/install-android-app) documentation for installation details. 
 
+```{Important}
+We strongly recommend using the latest mobile app release available that contains the latest security fixes and user experience enhancements. Mobile app releases are tested against all generally available Mattermost server and extended support releases.
+```
+
 ## Latest releases
 
 | **Release** | **Released on** | **Support ends** | **Compatible with** |

diff --git a/source/about/mattermost-server-releases.md b/source/about/mattermost-server-releases.md
@@ -5,8 +5,7 @@
 ```
 
 ```{Important}
- Support for Mattermost Server v9.11 [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) is coming to the end of its life cycle on May 15, 2025. Upgrading to Mattermost Server v10.5 or later is recommended.
-- Upgrading from ESR-to-ESR (``major`` -> ``major_next``) is fully supported and tested. However, upgrading from ESR-to-ESR (``major`` to ``major+2``) is supported, but not tested. If you plan to upgrade across multiple releases, we strongly recommend upgrading from an ESR to another ESR. For example, if you're upgrading from the v8.1 ESR, upgrade to the [v9.5 ESR](https://docs.mattermost.com/about/mattermost-v9-changelog.html#release-v9-5-extended-support-release) or the v9.11 ESR.
+```{include} common-esr-support-upgrade.md
 ```
 
 ## Frequency

diff --git a/source/about/mattermost-v10-changelog.md b/source/about/mattermost-v10-changelog.md
@@ -1,10 +1,7 @@
 # v10 changelog
 
 ```{Important}
-Support for Mattermost Server v9.11 [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) is coming to the end of its life cycle on May 15, 2025. Upgrading to Mattermost Server v10.5 or later is recommended.
-- Upgrading from ESR-to-ESR (``major`` -> ``major_next``) is fully supported and tested. However, upgrading from ESR-to-ESR (``major`` to ``major+2``) is supported, but not tested. If you plan to upgrade across multiple releases, we strongly recommend upgrading from an ESR to another ESR. For example, if you're upgrading from the v8.1 ESR, upgrade to the [v9.5 ESR](https://docs.mattermost.com/about/mattermost-v9-changelog.html#release-v9-5-extended-support-release) or the v9.11 ESR.
-- See the [Important Upgrade Notes](https://docs.mattermost.com/upgrade/important-upgrade-notes.html) documentation for details on upgrading to a newer release.
-- See the [changelog in progress](https://bit.ly/2nK3cVf) for details about the upcoming release.
+```{include} common-esr-support-upgrade.md
 ```
 
 (release-v10.5-extended-support-release)=

diff --git a/source/about/mattermost-v9-changelog.md b/source/about/mattermost-v9-changelog.md
@@ -1,12 +1,11 @@
 # v9 changelog
 
+
 ```{Important}
-Support for Mattermost Server v9.11 [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) is coming to the end of its life cycle on May 15, 2025. Upgrading to Mattermost Server v10.5 or later is recommended.
-- Upgrading from ESR-to-ESR (``major`` -> ``major_next``) is fully supported and tested. However, upgrading from ESR-to-ESR (``major`` to ``major+2``) is supported, but not tested. If you plan to upgrade across multiple releases, we strongly recommend upgrading from an ESR to another ESR. For example, if you're upgrading from the v8.1 ESR, upgrade to the [v9.5 ESR](https://docs.mattermost.com/about/mattermost-v9-changelog.html#release-v9-5-extended-support-release) or the v9.11 ESR.
-- See the [Important Upgrade Notes](https://docs.mattermost.com/upgrade/important-upgrade-notes.html) documentation for details on upgrading to a newer release.
-- See the [changelog in progress](https://bit.ly/2nK3cVf) for details about the upcoming release.
+```{include} common-esr-support-upgrade.md
 ```
 
+
 (release-v9-11-extended-support-release)=
 ## Release v9.11 - [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#release-types)
 

diff --git a/source/about/mobile-app-changelog.md b/source/about/mobile-app-changelog.md
@@ -5,6 +5,10 @@
 
 This changelog summarizes updates to Mattermost mobile apps releases for [Mattermost](https://mattermost.com).
 
+```{Important}
+```{include} common-esr-support.md
+```
+
 (release-v2-25-0)=
 ## 2.25.0 Release
  - Release Date: February 14, 2025

diff --git a/source/about/releases-lifecycle.rst b/source/about/releases-lifecycle.rst
@@ -6,7 +6,8 @@ Releases and life cycle
 
 .. important::
 
-  Support for Mattermost Server v8.1 :ref:`Extended Support Release <about/release-policy:extended support releases>` has come to the end of its life cycle in May 15, 2024. Upgrading to Mattermost Server v9.5 or later is required.
+
+  .. include:: ../about/common-esr-support-rst.rst
 
 .. toctree::
    :maxdepth: 1

diff --git a/source/about/unsupported-legacy-releases.md b/source/about/unsupported-legacy-releases.md
@@ -4,8 +4,7 @@
 ## Release v8.1 - [Extended Support Release](https://docs.mattermost.com/upgrade/release-definitions.html#extended-support-release-esr)
 
 ```{Important}
-- Support for Mattermost Server v8.1 [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) has come to the end of its life cycle on May 15, 2024. [Upgrading Mattermost Server](https://docs.mattermost.com/about/mattermost-server-releases.html#latest-releases) is required.
-- Upgrading from ESR-to-ESR (``major`` -> ``major_next``) is fully supported and tested. However, upgrading from ESR-to-ESR (``major`` to ``major+2``) is supported, but not tested. If you plan to upgrade across multiple releases, we strongly recommend upgrading from an ESR to another ESR. For example, if you're upgrading from the v8.1 ESR, upgrade to the [v9.5 ESR](https://docs.mattermost.com/about/mattermost-v9-changelog.html#release-v9-5-extended-support-release) or the v9.11 ESR.
+```{include} common-esr-support-upgrade.md
 ```
 
 - **8.1.13, released 2024-04-25**

diff --git a/source/about/version-archive.rst b/source/about/version-archive.rst
@@ -5,9 +5,14 @@ Version archive
   :start-after: :nosearch:
 
 .. important::
-  - Support for Mattermost Server v9.11 :ref:`Extended Support Release <about/release-policy:extended support releases>` is coming to the end of its life cycle on May 15, 2025. Upgrading to Mattermost Server v10.5 or later is recommended.
-  - Note that our package signing key has been moved away from Keybase. If you still reference Keybase in your deployment steps for retrieving the key, update them to the new key location: https://deb.packages.mattermost.com/pubkey.gpg.
-  - If you want to check that the version of Mattermost you are installing is the official, unmodified version, compare the SHA-256 checksum or the file's GPG signature with the one published in this version archive. To verify the GPG signature of a Mattermost release, use the public key stored at the following URL: https://deb.packages.mattermost.com/pubkey.gpg.
+
+  .. include:: ../about/common-esr-support-rst.rst
+
+If you want to check that the version of Mattermost you are installing is the official, unmodified version, compare the SHA-256 checksum or the file's GPG signature with the one published in this version archive. To verify the GPG signature of a Mattermost release, use the public key stored at the following URL: https://deb.packages.mattermost.com/pubkey.gpg.
+
+.. note::
+
+  Our package signing key has been moved away from Keybase. If you still reference Keybase in your deployment steps for retrieving the key, update them to the new key location: https://deb.packages.mattermost.com/pubkey.gpg.
 
 .. tab:: Mattermost Enterprise
 

diff --git a/source/conf.py b/source/conf.py
@@ -3778,7 +3778,7 @@ def setup(_: Sphinx):
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ["archive/*", "process/*"]
+exclude_patterns = ["archive/*", "process/*", "/about/common-esr-support.md", "/about/common-esr-support-upgrade.md"]
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.

diff --git a/source/install/prepare-mattermost-mysql-database.rst b/source/install/prepare-mattermost-mysql-database.rst
@@ -8,7 +8,8 @@ Prepare your Mattermost MySQL database
 
 .. important::
 
-    PostgreSQL is our preferred database of choice. See the :ref:`database software <install/software-hardware-requirements:database software>` documentation for details on database version support, and see the :doc:`Migrate from MySQL to PostgreSQL </deploy/postgres-migration>` documentation for details on migrating from MySQL to PostgreSQL.
+  - PostgreSQL is our preferred database of choice. See the :ref:`database software <install/software-hardware-requirements:database software>` documentation for details on database version support, and see the :doc:`Migrate from MySQL to PostgreSQL </deploy/postgres-migration>` documentation for details on migrating from MySQL to PostgreSQL.
+  - MySQL 8.0.22 contains an `issue with JSON column types <https://bugs.mysql.com/bug.php?id=101284>`__ changing string values to integers which is preventing Mattermost from working properly. Users are advised to avoid this database version.
 
 Set up the Mattermost MySQL database
 ------------------------------------

diff --git a/source/install/software-hardware-requirements.rst b/source/install/software-hardware-requirements.rst
@@ -124,6 +124,10 @@ Search limitations on MySQL:
 MySQL 8 Support
 ::::::::::::::::
 
+.. important::
+
+    MySQL 8.0.22 contains an `issue with JSON column types <https://bugs.mysql.com/bug.php?id=101284>`__ changing string values to integers which is preventing Mattermost from working properly. Users are advised to avoid this database version.
+
 In MySQL 8.0.4, the default authentication plugin was changed from ``mysql_native_password`` to ``caching_sha2_password``. Therefore, you will need to enable ``mysql_native_password`` by adding the following entry in your MySQL configuration file:
 
   .. code-block:: text

diff --git a/source/upgrade/important-upgrade-notes.rst b/source/upgrade/important-upgrade-notes.rst
@@ -1,16 +1,21 @@
 Important Upgrade Notes
 =======================
 
-.. include:: ../_static/badges/allplans-selfhosted.rst
-  :start-after: :nosearch:
-
 .. important::
-   - Support for Mattermost Server v9.11 :ref:`Extended Support Release <about/release-policy:extended support releases>` is coming to the end of its life cycle on May 15, 2025. Upgrading to Mattermost Server v10.5 or later is recommended.
-   - MySQL 8.0.22 contains an `issue with JSON column types <https://bugs.mysql.com/bug.php?id=101284>`__ changing string values to integers which is preventing Mattermost from working properly. Users are advised to avoid this database version.
-   - Upgrading the Microsoft Teams Calling plugin to v2.0.0 requires users to reconnect their accounts.
-   - When upgrading to 7.x from a 5.x release please make sure to upgrade to 5.37.10 first for the upgrade to complete successfully.
-   - Mattermost plugins built with Go versions 1.22.0 and 1.22.1 do not work. Plugin developers should use go 1.22.2 or newer instead.
-   - Keybase has stopped serving our Ubuntu repository signing key. If you were using it, update your installation scripts to retrieve the key as mentioned in our docs: https://docs.mattermost.com/install/install-ubuntu.html.
+
+  .. include:: ../about/common-esr-support-rst.rst
+
+
+.. note::
+
+  - Upgrading the Microsoft Teams Calling plugin to v2.0.0 requires users to reconnect their accounts.
+  - Mattermost plugins built with Go versions 1.22.0 and 1.22.1 do not work. Plugin developers should use Go 1.22.2 or newer instead.
+  - Keybase has stopped serving our Ubuntu repository signing key. If you were using it, update your installation scripts to retrieve the key as mentioned in our docs: https://docs.mattermost.com/install/install-ubuntu.html.
+  - MySQL 8.0.22 contains an `issue with JSON column types <https://bugs.mysql.com/bug.php?id=101284>`__ changing string values to integers which is preventing Mattermost from working properly. Users are advised to avoid this database version.
+  - Upgrading the Microsoft Teams Calling plugin to v2.0.0 requires users to reconnect their accounts.
+  - When upgrading to 7.x from a 5.x release please make sure to upgrade to 5.37.10 first for the upgrade to complete successfully.
+  - Mattermost plugins built with Go versions 1.22.0 and 1.22.1 do not work. Plugin developers should use go 1.22.2 or newer instead.
+  - Keybase has stopped serving our Ubuntu repository signing key. If you were using it, update your installation scripts to retrieve the key as mentioned in our docs: https://docs.mattermost.com/install/install-ubuntu.html.
 
 +----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | If you’re upgrading                                | Then...                                                                                                                                                          |
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Support for Mattermost Server v9.11 :ref:`Extended Support Release <about/release-policy:extended support releases>` is coming to the end of its life cycle on May 15, 2025. Upgrading to :doc:`Mattermost Server v10.5 or later </about/mattermost-server-releases>` is required.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Support for Mattermost Server v9.11 [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) is coming to the end of its life cycle on May 15, 2025. Upgrading to [Mattermost Server v10.5](https://docs.mattermost.com/about/mattermost-v10-changelog.html#release-v10-5-extended-support-release) or later is required.