From f16c117734913c3838155d837d6a8a18878dfbc4 Mon Sep 17 00:00:00 2001 From: "Carrie Warner (Mattermost)" <74422101+cwarnermm@users.noreply.github.com> Date: Tue, 10 Sep 2024 12:34:41 -0400 Subject: [PATCH 1/2] Doc'd prepkg'd plugin install paths & cloud-available list --- source/about/cloud-dedicated.rst | 5 ++- source/about/cloud-shared.rst | 7 ++++- source/about/cloud-supported-integrations.rst | 16 ++++++++++ source/about/integrations.rst | 31 ++++++++++--------- source/conf.py | 2 ++ source/configure/manage-user-surveys.rst | 21 +++++++------ source/guides/integrate-and-extend.rst | 3 +- .../microsoft-calendar-interoperability.rst | 16 +++++++--- .../microsoft-teams-interoperability.rst | 4 +++ ...rosoft-teams-meetings-interoperability.rst | 18 ++++++++--- 10 files changed, 86 insertions(+), 37 deletions(-) create mode 100644 source/about/cloud-supported-integrations.rst diff --git a/source/about/cloud-dedicated.rst b/source/about/cloud-dedicated.rst index 7febdc2725f..b08205c5bbc 100644 --- a/source/about/cloud-dedicated.rst +++ b/source/about/cloud-dedicated.rst @@ -90,7 +90,10 @@ Mattermost Cloud Dedicated provides access to :doc:`audit and system logs `_. See the :ref:`plugins ` documentation for details on supported plugins in Mattermost Cloud deployments. +Approved plugins developed and/or tested by Mattermost are supported and available in the `Mattermost Cloud Marketplace `_, including: + +.. include:: ./cloud-supported-integrations.rst + :start-after: :nosearch: Migrate from a self-hosted instance ------------------------------------ diff --git a/source/about/cloud-shared.rst b/source/about/cloud-shared.rst index c0209d2308a..3d14265583c 100644 --- a/source/about/cloud-shared.rst +++ b/source/about/cloud-shared.rst @@ -90,7 +90,12 @@ Mattermost Cloud Dedicated provides access to :doc:`audit and system logs `_. Custom plugins and integrations outside of Mattermost Marketplace aren’t currently supported. See the :ref:`plugins ` documentation for details on supported plugins in Mattermost Cloud deployments. +Approved plugins developed and/or tested by Mattermost are supported and available in the `Mattermost Cloud Marketplace `_, including: + +.. include:: ./cloud-supported-integrations.rst + :start-after: :nosearch: + +Custom plugins and integrations outside of Mattermost Marketplace aren’t currently supported. Migrate from a self-hosted instance ------------------------------------ diff --git a/source/about/cloud-supported-integrations.rst b/source/about/cloud-supported-integrations.rst new file mode 100644 index 00000000000..0e382b4c22a --- /dev/null +++ b/source/about/cloud-supported-integrations.rst @@ -0,0 +1,16 @@ +:orphan: +:nosearch: + +- :ref:`Mattermost Calls ` +- :doc:`Mattermost Copilot ` +- :doc:`Mattermost for Microsoft Teams ` interoperability +- :doc:`Mattermost Playbooks ` +- :doc:`Microsoft Calendar ` interoperability +- :doc:`Microsoft Teams Meetings ` interoperability +- :doc:`GitHub ` interoperability +- :doc:`GitLab ` interoperability +- :doc:`Jira ` interoperability +- :doc:`ServiceNow ` interoperability +- :doc:`User Survey ` integration +- :doc:`User satisfaction surveys ` +- :doc:`Zoom ` \ No newline at end of file diff --git a/source/about/integrations.rst b/source/about/integrations.rst index 7272320b2fb..177c9e9de59 100644 --- a/source/about/integrations.rst +++ b/source/about/integrations.rst @@ -3,7 +3,7 @@ Integrations overview Mattermost provides a variety of methods to add functionality and customize the end-user experience to suit your organization’s needs, whether you want to add new user capabilities with slash commands, build an advanced chatbot, or completely change the functionality of your server. -A wide array of open source integrations are available and ready to use from Mattermost and our community. To see a list of open source integrations please see the `Mattermost Marketplace `__. +A wide array of open source integrations are available and ready to use from Mattermost and our community. To see a list of open source integrations please see the `Mattermost Marketplace `_. For self-hosted deployments in small setups, you might host integrations on the same server on which Mattermost is installed. For larger deployments, you can set up a separate server for integrations, or add them to the server on which the external application is hosted. For example, if you’re self-hosting a Jira server, you could deploy a Jira integration on the Jira server itself. When self-hosting restrictions are less strict, AWS, Heroku, and other public cloud options can also be used. @@ -14,42 +14,43 @@ Custom Apps Apps are lightweight, interactive add-ons that can be written in any language and run on any HTTP-compatible hosting service. They enable you to connect with external services and build interactions that users can easily follow and work across the Mattermost web app, desktop app, and mobile app. -Prebuilt apps are available on the `Mattermost Marketplace `__. +Prebuilt apps are available on the `Mattermost Marketplace `_. API ---- -Mattermost provides complete access to `server APIs `__, along with language-specific drivers to integrate into your own applications. Interact with users, channels, and everything else that happens on your Mattermost server via a REST API that meets the OpenAPI specification. The API is for developers who want to build bots and other interactions that don’t rely on customizing the Mattermost user experience. - -`View the Mattermost API Reference `__. +Mattermost provides complete access to `server APIs via the Mattermost API Reference `_, along with language-specific drivers to integrate into your own applications. Interact with users, channels, and everything else that happens on your Mattermost server via a REST API that meets the OpenAPI specification. The API is for developers who want to build bots and other interactions that don’t rely on customizing the Mattermost user experience. Plugins ------- Plugins are the most comprehensive way to add new features and customization to self-hosted Mattermost deployments. These powerful integrations are written in Go and React and they’re ideal for customers wanting to change the behavior of the Mattermost server, desktop, and web apps without forking the core codebase to suit their organization’s needs. -Prebuilt plugins are available on the `Mattermost Marketplace `__, or you can `build your own plugin `__. +Prebuilt plugins are available on the `Mattermost Marketplace `_, or you can `build your own plugin `_. .. note:: - - :doc:`Mattermost Cloud Dedicated ` customers supports custom Mattermost plugin uploads. - - Custom Mattermost plugins aren't available in :doc:`Mattermost Cloud Shared ` deployments. You're limited to the plugins available in the Cloud Marketplace, including: :ref:`Mattermost Calls `, :doc:`Mattermost Copilot `, :doc:`GitHub ` interoperability, :doc:`GitLab ` interoperability, :doc:`Jira ` interoperability, :doc:`Playbooks `, :doc:`ServiceNow ` interoperability, :doc:`user satisfaction surveys `, and :doc:`Zoom `. + - :doc:`Mattermost Cloud Dedicated ` customers supports custom Mattermost plugin uploads. + - Custom Mattermost plugins aren't available in :doc:`Mattermost Cloud Shared ` deployments. You're limited to the plugins available in the Cloud Marketplace, including: + + .. include:: ./cloud-supported-integrations.rst + :start-after: :nosearch: Bots ----- You can deploy interactive bots to help users with processes and tasks with Mattermost by issuing messages to users they can respond to using buttons and dropdown menus. Bots can be used together with apps and plugins. The Hubot open source project, created by GitHub, Inc., is among the most popular of the bot options. -Prebuilt bots are available on the `Mattermost Marketplace `__, or you can `configure your own bots `__. +Prebuilt bots are available on the `Mattermost Marketplace `_, or you can `configure your own bots `_. -Learn about `Mattermost Hubot integration (hubot-matteruser on npm) `__ and `other open source community bots available `__ or you can `build your own `__. +Learn about `Mattermost Hubot integration (hubot-matteruser on npm) `_ and `other open source community bots available `_ or you can `build your own `_. Custom slash commands --------------------- -A :doc:`slash command ` is similar to an `outgoing webhooks `__, but instead of listening to a channel, it's used as a command tool in a channel. +A :doc:`slash command ` is similar to an `outgoing webhooks `_, but instead of listening to a channel, it's used as a command tool in a channel. -Slash commands enable users to trigger custom actions, such as creating Jira tickets or GitHub pull requests within Mattermost channels. See the :doc:`built-in slash commands ` product documentation and the `custom slash command `__ developer documentation to learn more. +Slash commands enable users to trigger custom actions, such as creating Jira tickets or GitHub pull requests within Mattermost channels. See the :doc:`built-in slash commands ` product documentation and the `custom slash command `_ developer documentation to learn more. .. tip:: The Mattermost slash command format is compatible with Slack's format, so you can easily port commands from Slack. @@ -57,9 +58,9 @@ Slash commands enable users to trigger custom actions, such as creating Jira tic Webhooks -------- -A webhook is a way for one app to send real-time data to another app. In Mattermost, `incoming webhooks `__ receive data from external applications and make a post in a specified channel. They’re great for setting up notifications when something happens in an external application. +A webhook is a way for one app to send real-time data to another app. In Mattermost, `incoming webhooks `_ receive data from external applications and make a post in a specified channel. They’re great for setting up notifications when something happens in an external application. -`Outgoing webhooks `__ take data from Mattermost, and send it to an external application. Then the outgoing webhook can post a response back in Mattermost. They’re great for listening in on channels, and then notifying external applications when a trigger word is used. +`Outgoing webhooks `_ take data from Mattermost, and send it to an external application. Then the outgoing webhook can post a response back in Mattermost. They’re great for listening in on channels, and then notifying external applications when a trigger word is used. .. tip:: @@ -71,4 +72,4 @@ Source code customizations -------------------------- As an open source project, we support your ability to modify the source code for the server or web app to make changes and customizations to meet your specific needs. -Learn about `forking our open source repositories `__. +Learn about `forking our open source repositories `_. diff --git a/source/conf.py b/source/conf.py index e436ad3fd00..37bb97c175a 100644 --- a/source/conf.py +++ b/source/conf.py @@ -1837,6 +1837,8 @@ def setup(_: Sphinx): "https://docs.mattermost.com/configure/site-configuration-settings.html#enable-system-wide-notifications", "configure/plugins-configuration-settings.html#playbooks": "https://docs.mattermost.com/configure/plugins-configuration-settings.html#collaborative-playbooks", +"configure/manage-user-surveys.html#upload": + "https://docs.mattermost.com/configure/manage-user-surveys.html#install", # Deploy redirects "deploy/mobile-apps-faq.html": diff --git a/source/configure/manage-user-surveys.rst b/source/configure/manage-user-surveys.rst index 33aa5a29ebe..428399f22de 100644 --- a/source/configure/manage-user-surveys.rst +++ b/source/configure/manage-user-surveys.rst @@ -15,25 +15,26 @@ You must be a Mattermost system admin to `upload the plugin <#upload>`__ to your The User Survey integration is compatible with the following Mattermost Server versions: + - v9.11.2 (Extended Support Release) - v9.8 or later - v9.5.2+ (Extended Support Release) - v8.1 (Extended Support Release) -Upload ------- +Install +-------- -The User Survey integration must be installed using the `latest binary available for download from the plugin repository `_ +.. important:: -1. Download the binary file from the GitHub repository. -2. Go to **System Console > Plugin Management**. -3. Next to **Upload Plugin**, select **Choose File**. -4. Select the binary file, select **Open**, and then select **Upload**. + Mattermost offers an additonal :doc:`User Satisfaction Surveys ` option with limited customization options within the **Plugins** list where surveys are enabled by default. We recommend :ref:`disabling the User Satisfaction Surveys functionality ` when using this user survey integration. -Once the binary is uploaded, the **User Survey** integration is added in the navigation pane under **Plugins**. +1. Log in to your Mattermost workspace as a system administrator. +2. In Mattermost, from the Product menu |product-list|, select **App Marketplace**. +3. Search for or scroll to User Survey, and select **Install**. +4. Once installed, select **Configure**. You're taken to the System Console, directly to the **User Survey** integration page, under **Plugins**. .. note:: - Mattermost offers an additonal :doc:`User Satisfaction Surveys ` option with limited customization options within the **Plugins** list where surveys are enabled by default. We recommend :ref:`disabling the User Satisfaction Surveys functionality ` when using this user survey integration. + From Mattermost v9.11.2 (ESR) and Mattermost Cloud v10, 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 `, and upload it to your server via **System Console > Plugin Management**. Upgrade ~~~~~~~ @@ -50,7 +51,7 @@ Go to **System Console > Plugins > User Survey** to enable this integration. Once the integration is installed and enabled, create surveys by completing configuration in the System Console, as described below. Create surveys --------------- +~~~~~~~~~~~~~~~ Under **Survey setup**, specify the date, time, and details for a new survey: diff --git a/source/guides/integrate-and-extend.rst b/source/guides/integrate-and-extend.rst index 9b5cb2c9bae..be463fbddb8 100644 --- a/source/guides/integrate-and-extend.rst +++ b/source/guides/integrate-and-extend.rst @@ -26,7 +26,8 @@ Your Mattermost deployment comes with the following integrations you can configu * :doc:`GitHub interoperability ` - Connect your GitHub instance to your Mattermost instance to subscribe to repositiories, and to stay current with reviews, assignments, and more. * :doc:`GitLab interoperability ` - Connect your GitLab instance to your Mattermost instance to subscribe to repositories, use GitLab events as Mattermost action triggers, and more. * :doc:`Jira interoperability ` - Connect your Jira instance to your Mattermost instance to create Jira tickets from messages in Mattermost, and to get notified of important Jira updates in Mattermost. -* :doc:`Mattermost Playbooks for Microsoft Teams ` - Improve cross-organizational alignment and awareness by enabling access to your active, repeatable processes and status updates in Mattermost directly in Microsoft Teams.* :doc:`Microsoft Calendar interoperability ` - Connect your Microsoft O365 Calendar to your Mattermost instance to receive daily sumamryies of calendar events, synchronize your Microsoft O365 status in Mattermost, and accept or decline calendar invites without leaving Mattermost. +* :doc:`Mattermost Playbooks for Microsoft Teams ` - Improve cross-organizational alignment and awareness by enabling access to your active, repeatable processes and status updates in Mattermost directly in Microsoft Teams. +* :doc:`Microsoft Calendar interoperability ` - Connect your Microsoft O365 Calendar to your Mattermost instance to receive daily sumamryies of calendar events, synchronize your Microsoft O365 status in Mattermost, and accept or decline calendar invites without leaving Mattermost. * :doc:`Microsoft Teams interoperability ` - Connect your Microsoft Teams instance to your Mattermost instance to forward real-time chat notifications from Teams to Mattermost. * :doc:`Microsoft Teams Meetings interoperability ` - Connect your Microsoft Teams Meetings instance to your Mattermost instance to start and join voice calls, video calls, and use screen sharing without leaving Mattermost. * :doc:`ServiceNow interoperability ` - Connect your ServiceNow instance to your Mattermost instance to subscribe to record changes in ServiceNow and manage them in Mattermost. diff --git a/source/integrate/microsoft-calendar-interoperability.rst b/source/integrate/microsoft-calendar-interoperability.rst index 3981a3a6ca8..cc9ee370794 100644 --- a/source/integrate/microsoft-calendar-interoperability.rst +++ b/source/integrate/microsoft-calendar-interoperability.rst @@ -72,6 +72,18 @@ Create a Mattermost App in Azure You're all set for configuration in the Azure portal. +Install the Microsoft Calendar integration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +1. Log in to your Mattermost workspace as a system administrator. +2. In Mattermost, from the Product menu |product-list|, select **App Marketplace**. +3. Search for or scroll to Microsoft Calendar, and select **Install**. +4. Once installed, select **Configure**. You're taken to the System Console, directly to the **Microsoft Calendar** integration page, under **Plugins**. + +.. note:: + + From Mattermost v9.11.2 (ESR) and Mattermost Cloud v10, 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 `, and upload it to your server via **System Console > Plugin Management**. + Enable and configure the Microsoft Calendar integration in Mattermost ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -82,10 +94,6 @@ Enable and configure the Microsoft Calendar integration in Mattermost 2. In Mattermost, go to **System Console > Plugins > Microsoft Calendar** to enable this integration. -.. note:: - - From Mattermost v10, this plugin is pre-packaged with the Mattermost Server. If your Mattermost deployment is on a release prior to v10, download the `latest plugin binary release `, and upload it to your server via **System Console > Plugin Management**. - 3. Copy the **Application (client) ID** and **Directory (tenant) ID** from the Azure portal. 4. In Mattermost, enter the following values in the fields provided. Select **Save** to apply the configuration: diff --git a/source/integrate/microsoft-teams-interoperability.rst b/source/integrate/microsoft-teams-interoperability.rst index 19c46f79302..3a41b66b5e2 100644 --- a/source/integrate/microsoft-teams-interoperability.rst +++ b/source/integrate/microsoft-teams-interoperability.rst @@ -99,6 +99,10 @@ Install and configure the Microsoft Teams integration in Mattermost See the :ref:`Microsoft Teams plugin configuration settings ` documentation for additional configuration options. +.. 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 `, and upload it to your server via **System Console > Plugin Management**. + Monitor performance -------------------- diff --git a/source/integrate/microsoft-teams-meetings-interoperability.rst b/source/integrate/microsoft-teams-meetings-interoperability.rst index 0c73738eb2a..757a0b0077e 100644 --- a/source/integrate/microsoft-teams-meetings-interoperability.rst +++ b/source/integrate/microsoft-teams-meetings-interoperability.rst @@ -62,6 +62,18 @@ Create a Mattermost App in Azure You're all set for configuration inside of the Azure portal. +Install the Microsoft Teams Meetings integration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +1. Log in to your Mattermost workspace as a system administrator. +2. In Mattermost, from the Product menu |product-list|, select **App Marketplace**. +3. Search for or scroll to MS Teams Meetings, and select **Install**. +4. Once installed, select **Configure**. You're taken to the System Console, directly to the **MS Teams Meetings** integration page, under **Plugins**. + +.. note:: + + From Mattermost v9.11.2 (ESR) and Mattermost Cloud v10, 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 `, and upload it to your server via **System Console > Plugin Management**. + Enable and configure the Microsoft Teams Meetings integration in Mattermost ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -70,11 +82,7 @@ Enable and configure the Microsoft Teams Meetings integration in Mattermost .. image:: ../images/ms-teams-meetings-copy-ids.png :alt: In Azure, copy the Client ID and Tenant ID values. -2. In Mattermost, go to **System Console > Plugins > Microsoft Calendar** to enable this integration. - -.. note:: - - From Mattermost v10, this plugin is pre-packaged with the Mattermost Server. If your Mattermost deployment is on a release prior to v10, download the `latest plugin binary release `, and upload it to your server via **System Console > Plugin Management**. +2. In Mattermost, go to **System Console > Plugins > MS Teams Meetings** to enable this integration. 3. In Mattermost, enter the following values in the fields provided. Select **Save** to apply the configuration: From fc8020b1ce33ba1fc75445bab9b82a36cf75fb3f Mon Sep 17 00:00:00 2001 From: "Carrie Warner (Mattermost)" <74422101+cwarnermm@users.noreply.github.com> Date: Fri, 13 Sep 2024 14:42:20 -0400 Subject: [PATCH 2/2] RST syntax updates --- source/configure/manage-user-surveys.rst | 2 +- source/integrate/microsoft-calendar-interoperability.rst | 2 +- source/integrate/microsoft-teams-interoperability.rst | 2 +- source/integrate/microsoft-teams-meetings-interoperability.rst | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/source/configure/manage-user-surveys.rst b/source/configure/manage-user-surveys.rst index 428399f22de..3e30ad2823e 100644 --- a/source/configure/manage-user-surveys.rst +++ b/source/configure/manage-user-surveys.rst @@ -34,7 +34,7 @@ Install .. note:: - From Mattermost v9.11.2 (ESR) and Mattermost Cloud v10, 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 `, and upload it to your server via **System Console > Plugin Management**. + From Mattermost v9.11.2 (ESR) and Mattermost Cloud v10, 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 `_, and upload it to your server via **System Console > Plugin Management**. Upgrade ~~~~~~~ diff --git a/source/integrate/microsoft-calendar-interoperability.rst b/source/integrate/microsoft-calendar-interoperability.rst index cc9ee370794..6ed8fc01fbd 100644 --- a/source/integrate/microsoft-calendar-interoperability.rst +++ b/source/integrate/microsoft-calendar-interoperability.rst @@ -82,7 +82,7 @@ Install the Microsoft Calendar integration .. note:: - From Mattermost v9.11.2 (ESR) and Mattermost Cloud v10, 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 `, and upload it to your server via **System Console > Plugin Management**. + From Mattermost v9.11.2 (ESR) and Mattermost Cloud v10, 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 `_, and upload it to your server via **System Console > Plugin Management**. Enable and configure the Microsoft Calendar integration in Mattermost ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/integrate/microsoft-teams-interoperability.rst b/source/integrate/microsoft-teams-interoperability.rst index 3a41b66b5e2..77a0bf196df 100644 --- a/source/integrate/microsoft-teams-interoperability.rst +++ b/source/integrate/microsoft-teams-interoperability.rst @@ -101,7 +101,7 @@ See the :ref:`Microsoft Teams plugin configuration settings `, 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 `_, and upload it to your server via **System Console > Plugin Management**. Monitor performance -------------------- diff --git a/source/integrate/microsoft-teams-meetings-interoperability.rst b/source/integrate/microsoft-teams-meetings-interoperability.rst index 757a0b0077e..bdae4064a79 100644 --- a/source/integrate/microsoft-teams-meetings-interoperability.rst +++ b/source/integrate/microsoft-teams-meetings-interoperability.rst @@ -72,7 +72,7 @@ Install the Microsoft Teams Meetings integration .. note:: - From Mattermost v9.11.2 (ESR) and Mattermost Cloud v10, 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 `, and upload it to your server via **System Console > Plugin Management**. + From Mattermost v9.11.2 (ESR) and Mattermost Cloud v10, 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 `_, and upload it to your server via **System Console > Plugin Management**. Enable and configure the Microsoft Teams Meetings integration in Mattermost ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~