Skip to content

Commit

Permalink
Added upgrade & maintenance guidance for plugins
Browse files Browse the repository at this point in the history
  • Loading branch information
cwarnermm committed Nov 5, 2024
1 parent b2c46b5 commit 56409bd
Show file tree
Hide file tree
Showing 9 changed files with 70 additions and 4 deletions.
12 changes: 12 additions & 0 deletions source/guides/integrate-and-extend.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,15 @@ Your Mattermost deployment comes with the following integrations you can configu
.. tip::

Visit the `Mattermost Developer Documentation <https://developers.mattermost.com/integrate/getting-started/>`__ for details on developing `webhooks <https://developers.mattermost.com/integrate/webhooks>`__, developing `custom slash commands <https://developers.mattermost.com/integrate/slash-commands/custom/>`_, `custom plugins <https://developers.mattermost.com/integrate/plugins/>`__, building advanced bots and integrations using the `Mattermost REST API <https://api.mattermost.com/>`__, `embedding Mattermost <https://developers.mattermost.com/integrate/customization/embedding/>`__ into web browsers and web apps, `customizing the Mattermost source code <https://developers.mattermost.com/integrate/customization/customization/>`__, and developing `interactive messages <https://developers.mattermost.com/integrate/plugins/interactive-messages/>`__ on the Mattermost platform.

Mattermost Marketplace integrations
-----------------------------------

Additional Mattermost integrations are available on the `Mattermost Marketplace <https://mattermost.com/marketplace/>`_. You can install these integrations directly from the Marketplace, by uploading them in the System Console, or by using the REST API.

.. important::

- Manually placing Mattermost integration files in the ``/plugins`` directory isn't recommended.
- Mattermost uses the latest integration version available within the following directories: ``<installdirectory>/prepackaged-plugins`` and ``FileSettings.Directory/plugins``, where the latter is the source of truth for installed plugins and contains ``*.tar.gz`` files.
- We strongly recommend that system admins ensure that ``{{FileStore.Directory}}/plugins`` is mounted at startup to avoid integration downgrades.
- We also strongly recommend testing integration updates in a staging environment before deploying to production, and regularly backing up integrations.
5 changes: 5 additions & 0 deletions source/integrate/github-interoperability.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,11 @@ Upgrade

We recommend updating this integration as new versions are released. Generally, updates are seamless and don't interrupt the user experience in Mattermost. Visit the `Releases page <https://github.com/mattermost/mattermost-plugin-github/releases>`__ for the latest release, available releases, and compatibiilty considerations.

.. important::

- We strongly recommend removing older versions of this integration before uploading a new version. Mattermost server selects the newest integration version automatically, unless :ref:`automatic prepackaged plugins <configure/plugins-configuration-settings:automatic prepackaged plugins>` is disabled because precise control over plugin versions is preferred.
- Use the System Console, REST API, or in-product Marketplace to manage this integration. Manually placing Mattermost integration files in the ``/plugins`` directory isn't recommended.

Usage
-----

Expand Down
5 changes: 5 additions & 0 deletions source/integrate/gitlab-interoperability.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,11 @@ Upgrade

We recommend updating this integration as new versions are released. Generally, updates are seamless and don't interrupt the user experience in Mattermost. Visit the `Releases page <https://github.com/mattermost/mattermost-plugin-gitlab/releases>`__ for the latest release, available releases, and compatibiilty considerations.

.. important::

- We strongly recommend removing older versions of this integration before uploading a new version. Mattermost server selects the newest integration version automatically, unless :ref:`automatic prepackaged plugins <configure/plugins-configuration-settings:automatic prepackaged plugins>` is disabled because precise control over plugin versions is preferred.
- Use the System Console, REST API, or in-product Marketplace to manage this integration. Manually placing Mattermost integration files in the ``/plugins`` directory isn't recommended.

Usage
-----

Expand Down
5 changes: 5 additions & 0 deletions source/integrate/jira-interoperability.rst
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,11 @@ Upgrade

We recommend updating this integration as new versions are released. Generally, updates are seamless and don't interrupt the user experience in Mattermost. Visit the `Releases page <https://github.com/mattermost/mattermost-plugin-jira/releases>`__ for the latest release, available releases, and compatibiilty considerations.

.. important::

- We strongly recommend removing older versions of this integration before uploading a new version. Mattermost server selects the newest integration version automatically, unless :ref:`automatic prepackaged plugins <configure/plugins-configuration-settings:automatic prepackaged plugins>` is disabled because precise control over plugin versions is preferred.
- Use the System Console, REST API, or in-product Marketplace to manage this integration. Manually placing Mattermost integration files in the ``/plugins`` directory isn't recommended.

Usage
-----

Expand Down
12 changes: 11 additions & 1 deletion source/integrate/microsoft-calendar-interoperability.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,4 +112,14 @@ Usage

Users who want to use Microsoft Calendar interconnectivity must connect a Microsoft Office account to Mattermost.

Once connected, you'll receive direct messages from the Microsoft Calendar bot in Mattermost for Microsoft Calendar activity.
Once connected, you'll receive direct messages from the Microsoft Calendar bot in Mattermost for Microsoft Calendar activity.

Upgrade
-------

We recommend updating this integration as new versions are released. Generally, updates are seamless and don't interrupt the user experience in Mattermost. Visit the `Releases page <https://github.com/mattermost/mattermost-plugin-mscalendar/releases>`__ for the latest release, available releases, and compatibiilty considerations.

.. important::

- We strongly recommend removing older versions of this integration before uploading a new version. Mattermost server selects the newest integration version automatically, unless :ref:`automatic prepackaged plugins <configure/plugins-configuration-settings:automatic prepackaged plugins>` is disabled because precise control over plugin versions is preferred.
- Use the System Console, REST API, or in-product Marketplace to manage this integration. Manually placing Mattermost integration files in the ``/plugins`` directory isn't recommended.
12 changes: 11 additions & 1 deletion source/integrate/microsoft-teams-interoperability.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ See the :ref:`Microsoft Teams plugin configuration settings <configure/plugins-c

.. note::

- From Mattermost v9.11.2 (ESR) and Mattermost Cloud v10, v2.0 of this plugin is pre-packaged with the Mattermost Server. If your Mattermost deployment is on a release prior to v9.11.2, download the `latest plugin binary release <https://github.com/mattermost/mattermost-plugin-user-survey/releases>`_, and upload it to your server via **System Console > Plugin Management**.
- From Mattermost v9.11.2 (ESR) and Mattermost Cloud v10, v2.0 of this plugin is pre-packaged with the Mattermost Server. If your Mattermost deployment is on a release prior to v9.11.2, download the `latest plugin binary release <https://github.com/mattermost/mattermost-plugin-msteams>`_, and upload it to your server via **System Console > Plugin Management**.
- We recommend making a copy of your webhook secret and encryption key, as it will only be visible to you once.

Monitor performance
Expand All @@ -129,6 +129,16 @@ Usage

See the :doc:`collaborate within connected microsoft teams </collaborate/collaborate-within-connected-microsoft-teams>` product documentation to get started using Microsoft Teams interoperability.

Upgrade
-------

We recommend updating this integration as new versions are released. Generally, updates are seamless and don't interrupt the user experience in Mattermost. Visit the `Releases page <https://github.com/mattermost/mattermost-plugin-msteams>`__ for the latest release, available releases, and compatibiilty considerations.

.. important::

- We strongly recommend removing older versions of this integration before uploading a new version. Mattermost server selects the newest integration version automatically, unless :ref:`automatic prepackaged plugins <configure/plugins-configuration-settings:automatic prepackaged plugins>` is disabled because precise control over plugin versions is preferred.
- Use the System Console, REST API, or in-product Marketplace to manage this integration. Manually placing Mattermost integration files in the ``/plugins`` directory isn't recommended.

Frequently asked questions
--------------------------

Expand Down
10 changes: 10 additions & 0 deletions source/integrate/microsoft-teams-meetings-interoperability.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,16 @@ Disconnect a Microsoft Teams account from Mattermost

Run the `/mstmeetings disconnect` slash command to disconnect a Microsoft Teams account from Mattermost.

Upgrade
-------

We recommend updating this integration as new versions are released. Generally, updates are seamless and don't interrupt the user experience in Mattermost. Visit the `Releases page <https://github.com/mattermost/mattermost-plugin-mscalendar>`__ for the latest release, available releases, and compatibiilty considerations.

.. important::

- We strongly recommend removing older versions of this integration before uploading a new version. Mattermost server selects the newest integration version automatically, unless :ref:`automatic prepackaged plugins <configure/plugins-configuration-settings:automatic prepackaged plugins>` is disabled because precise control over plugin versions is preferred.
- Use the System Console, REST API, or in-product Marketplace to manage this integration. Manually placing Mattermost integration files in the ``/plugins`` directory isn't recommended.

Get help
--------

Expand Down
8 changes: 6 additions & 2 deletions source/integrate/servicenow-interoperability.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,12 @@ Notify your teams that they can `connect their ServiceNow accounts to Mattermost
Upgrade
-------

We recommend updating this integration as new versions are released. Generally, updates are seamless and don't interrupt the user experience in Mattermost.
Visit the `Releases page <https://github.com/mattermost/mattermost-plugin-servicenow/releases>`__ for the latest release, available releases, and compatibiilty considerations.
We recommend updating this integration as new versions are released. Generally, updates are seamless and don't interrupt the user experience in Mattermost. Visit the `Releases page <https://github.com/mattermost/mattermost-plugin-servicenow/releases>`__ for the latest release, available releases, and compatibiilty considerations.

.. important::

- We strongly recommend removing older versions of this integration before uploading a new version. Mattermost server selects the newest integration version automatically, unless :ref:`automatic prepackaged plugins <configure/plugins-configuration-settings:automatic prepackaged plugins>` is disabled because precise control over plugin versions is preferred.
- Use the System Console, REST API, or in-product Marketplace to manage this integration. Manually placing Mattermost integration files in the ``/plugins`` directory isn't recommended.

Usage
-----
Expand Down
5 changes: 5 additions & 0 deletions source/integrate/zoom-interoperability.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,11 @@ Upgrade

We recommend updating this integration when new versions are released. Generally, updates are seamless and don't interrupt the user experience in Mattermost. Visit the `Releases page <https://github.com/mattermost/mattermost-plugin-zoom/releases>`__ for information on the latest release, previous releases, and compatibiilty considerations.

.. important::

- We strongly recommend removing older versions of this integration before uploading a new version. Mattermost server selects the newest integration version automatically, unless :ref:`automatic prepackaged plugins <configure/plugins-configuration-settings:automatic prepackaged plugins>` is disabled because precise control over plugin versions is preferred.
- Use the System Console, REST API, or in-product Marketplace to manage this integration. Manually placing Mattermost integration files in the ``/plugins`` directory isn't recommended.

Usage
-----

Expand Down

0 comments on commit 56409bd

Please sign in to comment.