Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding Mattermost-supported plugins to product docs #7030

Merged
merged 32 commits into from
May 9, 2024
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
7f717c8
Adding Mattermost-supported plugins to product docs
cwarnermm Apr 3, 2024
272c695
Merge branch 'master' into mattermost-supported-integrations
cwarnermm Apr 12, 2024
b063d03
Merge branch 'master' into mattermost-supported-integrations
cwarnermm Apr 16, 2024
26bd302
Ongoing early iteration
cwarnermm Apr 16, 2024
b40771e
Ongoing early iteration & rewrites
cwarnermm Apr 17, 2024
702196f
Final scaffolding/structure drafts
cwarnermm Apr 19, 2024
36f370d
Merge branch 'master' into mattermost-supported-integrations
cwarnermm Apr 19, 2024
3baf86b
Added missing link
cwarnermm Apr 19, 2024
2046a3b
Merge branch 'mattermost-supported-integrations' of https://github.co…
cwarnermm Apr 19, 2024
7ad7a36
split out features from integrations
cwarnermm Apr 24, 2024
7bd0b2d
Merge branch 'master' into mattermost-supported-integrations
mattermost-build Apr 24, 2024
4dddf1a
Added Metrics plugin (#6916)
cwarnermm Apr 24, 2024
8b4ab5a
Filename updates
cwarnermm Apr 24, 2024
8afb083
Incorporated AI Copilot, added screenshots & plugin updates
cwarnermm Apr 26, 2024
9ce86bf
Updated AI Copilot integration details
cwarnermm Apr 30, 2024
cc05aac
Merge branch 'master' into mattermost-supported-integrations
cwarnermm Apr 30, 2024
9d2fcb9
Added AI Actions icon
cwarnermm Apr 30, 2024
6e4c660
Merge branch 'mattermost-supported-integrations' of https://github.co…
cwarnermm Apr 30, 2024
79cee78
Incorporated remaining updates; ready for reviews
cwarnermm May 2, 2024
3889671
Merge branch 'master' into mattermost-supported-integrations
cwarnermm May 2, 2024
f650e54
Link fix
cwarnermm May 6, 2024
133804e
Merge branch 'mattermost-supported-integrations' of https://github.co…
cwarnermm May 6, 2024
bad3be2
Merge branch 'master' into mattermost-supported-integrations
cwarnermm May 7, 2024
53618ce
Archived Google Calendar plugin docs (moved to GH repo)
cwarnermm May 7, 2024
19d6137
Updated docs page redirects to point to GH repo
cwarnermm May 7, 2024
94ed1e9
Merge branch 'master' into mattermost-supported-integrations
cwarnermm May 8, 2024
2f4c7cb
Migrating GH repo README content to product docs
cwarnermm May 8, 2024
159cda1
Update source/comply/export-mattermost-channel-data.rst
cwarnermm May 8, 2024
1355e9b
Update source/integrate/jira-interoperability.rst
cwarnermm May 8, 2024
2324697
Final PR updates consolidating pre-build MM integrations
cwarnermm May 9, 2024
d84ac27
Incorporated updates from https://github.com/mattermost/mattermost-pl…
cwarnermm May 9, 2024
a2acbaf
Added page redirects for Google Calendar integration > GH README
cwarnermm May 9, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/_templates/custom-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ <h4>Contribute</h4>
</div>
</a>
<a
href='https://developers.mattermost.com/integrate/getting-started/'
href='guides/integrate-and-extend.html'
class="masthead-card"
>
<div class="masthead-card__icon">
Expand Down
67 changes: 18 additions & 49 deletions source/about/install-mattermost-for-microsoft-teams-plugin.rst
Original file line number Diff line number Diff line change
@@ -1,27 +1,19 @@
Install the Mattermost for Microsoft Teams plugin
=================================================
:nosearch:

.. include:: ../_static/badges/ent-cloud-selfhosted.rst
:start-after: :nosearch:
Setup starts in Mattermost, moves to Microsoft Teams, and ends in Mattermost.

.. tip::

Looking to :doc:`embed Mattermost within Microsoft Teams </about/embed-mattermost-app-within-microsoft-teams>` instead?

To install the Microsoft Teams plugin in Mattermost:
Install the Microsoft Teams integration in Mattermost
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. Log in to your Mattermost workspace as a system administrator.
2. Download the latest version of `the plugin binary release <https://github.com/mattermost/mattermost-plugin-msteams/releases>`__, compatible with Mattermost v8.0.1 and later. If you are using an earlier version of Mattermost, :doc:`follow our documentation </upgrade/upgrading-mattermost-server>` to upgrade to Mattermost v8.0.1 or later.
3. Go to **System Console > Plugins > Plugin Management > Upload Plugin**, and upload the plugin binary you downloaded in the previous step.
4. Go to **System Console > Plugins > Plugin Management**. In the **Installed Plugins** section, scroll to **MS Teams**, and select **Enable Plugin**.

Set up an OAuth application in Azure
-------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Step 1: Create Mattermost App in Azure
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. Sign into `portal.azure.com <https://portal.azure.com>`__ using an admin Azure account.
1. Sign into `portal.azure.com <https://portal.azure.com>`_ using an admin Azure account.
2. Navigate to `App Registrations <https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredApps>`__.
3. Select **New registration** at the top of the page.

Expand Down Expand Up @@ -88,8 +80,8 @@ Replace ``(MM_SITE_URL)`` with your Mattermost server's Site URL. Select **Regis

14. Select **Grant admin consent for...** to grant the permissions for the application.

Step 2: Create a user account to act as a bot
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a user account to act as a bot
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. Create a regular user account. We will connect this account later from the Mattermost side.
2. This account is needed for creating messages on Microsoft Teams on behalf of users who are present in Mattermost but not on Microsoft Teams.
Expand All @@ -102,8 +94,8 @@ Step 2: Create a user account to act as a bot

After you've connected the bot user to the account on Microsoft Teams, all the messages that are posted from the account on Microsoft Teams won't be synchronized back to Mattermost since it's a "bot", and messages from bots are ignored.

Step 3: Ensure you have the metered APIs enabled (and the pay subscription associated to it)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Ensure you have the metered APIs enabled (and the pay subscription associated to it)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Follow the steps here: https://learn.microsoft.com/en-us/graph/metered-api-setup

Expand All @@ -113,24 +105,24 @@ Follow the steps here: https://learn.microsoft.com/en-us/graph/metered-api-setup

You're all set for configuration inside Azure.

Configure how users will connect accounts
------------------------------------------
Configure how users connect accounts
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Mattermost admins can configure Mattermost to automatically prompt users to connect their Mattermost user account to their Microsoft Teams user account on login.

1. Go to **System Console > Plugins > MS Teams**.
2. Enable **Enforce connected accounts** to prompt users to connect if they haven't done so.
3. (Optional) Enable **Allow to temporarily skip connect user** to allow users to skip the connection prompt temporarily. Users are prompted on refresh and login.

Configure the plugin
--------------------
Mattermost configuration
~~~~~~~~~~~~~~~~~~~~~~~~~

Additional configuration settings are available for this plugin. See the :ref:`Microsoft Teams plugin configuration settings <configure/plugins-configuration-settings:ms teams>` documentation for details.

Monitor plugin performance
--------------------------
Monitor performance
~~~~~~~~~~~~~~~~~~~~

You can set up :doc:`performance monitoring </scale/performance-monitoring>` and :doc:`performance alerting </scale/performance-alerting>` for this plugin using Prometheus and Grafana.
You can set up :doc:`performance monitoring </scale/performance-monitoring>` and :doc:`performance alerting </scale/performance-alerting>` for Microsoft Teams interoperability using Prometheus and Grafana.

- Monitoring enables you to proactively review the overall health of the plugin, including database calls, HTTP requests, and API latency.
- Alerting enables you to detect and take action as issues come up, such as the integration being offline.
Expand All @@ -142,27 +134,4 @@ Grafana dashboards `are available on GitHub <https://github.com/mattermost/matte

.. note::

Modifications will be necessary for self-hosted Mattermost deployments. See the `Get help <#get-help>`__ section below for details on how to contact us for assistance.

Get started with the plugin
---------------------------

See our :doc:`collaborate using the Microsoft Teams plugin </collaborate/collaborate-within-connected-microsoft-teams>` documentation for details on how to collaborate across both Mattermost and Microsoft Teams at the same time.

Trobleshooting FAQ
------------------

**Can I connect my Mattermost account to a Microsoft Teams account of a different email address?**

No. Currently, only accounts with the same email addresses are allowed to be connected. Specify the email address that matches your Mattermost account.

If connecting a Mattermost account to a Microsoft Teams account with a different email address is something your workspace requires, there is an open `GitHub issue <https://github.com/mattermost/mattermost-plugin-msteams/issues/519>`__ for you to share your feedback.

Get help
--------

If you face issues while installing this plugin, gather relevant information, including reproduction steps to accelerate troubleshooting. You're welcome to open a new issue in the `Mattermost for Microsoft Teams GitHub repository <https://github.com/mattermost/mattermost-plugin-msteams/issues/new>`__.

- **Mattermost Commercial Customers (including Enterprise and Professional plans)**: Visit `Mattermost Support <https://mattermost.com/support/>`__ to `submit a support ticket <https://support.mattermost.com/hc/en-us/requests/new>`__.

- **Mattermost Team Edition and Free customers** Visit the Mattermost `peer-to-peer troubleshooting forum <https://forum.mattermost.com/c/trouble-shoot/16>`__ where you can access the global Mattermost Community for assistance.
Modifications will be necessary for self-hosted Mattermost deployments. See the `Get help <#get-help>`__ section below for details on how to contact us for assistance.
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
Collaborate within Microsoft Teams (Pilot)
==========================================
:nosearch:

.. include:: ../_static/badges/ent-cloud-selfhosted.rst
:start-after: :nosearch:
Collaborate within Microsoft Teams (Pilot)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. |plus-icon| image:: ../images/plus_F0415.svg
:alt: Open menus using the plus icon.
Expand All @@ -14,7 +13,7 @@ The :doc:`Mattermost for Microsoft Teams plugin </about/mattermost-for-microsoft
:start-after: :nosearch:

Connect your Mattermost account to your Microsoft Teams account
---------------------------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To use the Microsoft Teams plugin, you must connect your Mattermost user account to your Microsoft Teams account. You only need to complete this step once.

Expand All @@ -29,7 +28,7 @@ To use the Microsoft Teams plugin, you must connect your Mattermost user account
Mattermost will confirm when your account is connected, and prompt you to select your primary platform.

Select your preferred platform
-------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Once you've connected your Mattermost account to your Microsoft Teams account, Mattermost prompts you to choose which platform you'll use more often: `Mattermost <#mattermost-is-your-preferred-platform>`_ or `Microsoft Teams <#microsoft-teams-is-your-preferred-platform>`_. Mattermost optimizes your experience based on the platform you prefer to use.

Expand All @@ -39,24 +38,24 @@ Once you've connected your Mattermost account to your Microsoft Teams account, M
- If you select **Skip for now**, Mattermost is selected as your primary platform. You can change this preference any time by selecting your profile picture and going to **Settings > MS Teams Settings**.

Mattermost is your preferred platform
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:::::::::::::::::::::::::::::::::::::

When Mattermost is preferred, you'll receive Microsoft Teams messages and notifications in Mattermost.

We recommend that you disable notifications in Microsoft Teams. If you don't, you'll receive duplicate message notifications in both platforms. See the `Microsoft Teams notifications documentation <https://support.microsoft.com/en-us/office/manage-notifications-in-microsoft-teams-1cc31834-5fe5-412b-8edb-43fecc78413d>`__ for details.

Microsoft Teams is your preferred platform
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:::::::::::::::::::::::::::::::::::::::::::

When Microsoft Teams is preferred, you'll receive messages from Mattermost in Microsoft Teams. Mattermost notifications are automatically muted for you to prevent duplicate notifications.

Setup complete
--------------
^^^^^^^^^^^^^^

Setup is complete! You're ready to collaborate across your organization. Interact with colleagues in Microsoft Teams without having to leave Mattermost.

Get started
-----------
^^^^^^^^^^^

You can start a direct or group message between Mattermost and Microsoft Teams users unless your Mattermost administrator has :ref:`disabled the ability to do so in the System Console <configure/plugins-configuration-settings:sync direct and group messages>`.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
Collaborate within embedded Microsoft Teams
===========================================
:nosearch:

.. include:: ../_static/badges/ent-cloud-selfhosted.rst
:start-after: :nosearch:
Collaborate within embedded Microsoft Teams (Demo)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The :doc:`Mattermost for Microsoft Teams plugin </about/mattermost-for-microsoft-teams>` enables you to collaborate with technical & operations teams seamlessly through the Mattermost app, without leaving Microsoft Teams.

Demonstration: Mattermost embedded in Microsoft Teams
------------------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Check out this `YouTube demo <https://youtu.be/2t2CsC5JWPw>`__, from John Landells, Senior Technical Account Manager at Mattermost, to learn more about using the embedded Mattermost instance within Microsoft Teams:

.. raw:: html

<iframe width="560" height="315" src="https://www.youtube.com/embed/2t2CsC5JWPw" alt="Install Mattermost for Microsoft Teams plugin" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
<iframe width="560" height="315" src="https://www.youtube.com/embed/2t2CsC5JWPw" alt="Install Mattermost for Microsoft Teams plugin" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
38 changes: 16 additions & 22 deletions source/collaborate/extend-mattermost-with-integrations.rst
Original file line number Diff line number Diff line change
@@ -1,30 +1,24 @@
Extend Mattermost with integrations
===================================

`Visit the Mattermost Marketplace <https://mattermost.com/marketplace/>`__ to find open source integrations to common developer tools like `CircleCI <https://mattermost.com/marketplace/circleci/>`__, `Opsgenie <https://mattermost.com/marketplace/opsgenie/>`__, `PagerDuty Notifier <https://mattermost.com/marketplace/pagerduty/>`__, and `Zendesk App <https://mattermost.com/marketplace/zendesk-app/>`__; productivity tools like `Autolink <https://mattermost.com/marketplace/autolink-plugin/>`__, `ToDo <https://mattermost.com/marketplace/todo/>`__, and `WelcomeBot <https://mattermost.com/marketplace/welcomebot-plugin/>`__; as well as social tools like `Memes <https://mattermost.com/marketplace/memes-plugin/>`__ and `GIFs <https://mattermost.com/marketplace/giphy-plugin/>`__ that are freely available for use and customization.
Ensure your teams are are always informed about important events, status changes, deadlines, or priorities with Mattermost integrations. Enhance communication, streamline Mattermost with external workflows, ensure security and compliance, and foster a more efficient and collaborative work environment with major communication tools and services featuring real-time alerts, updates, and notifications directly within channels.

Pre-packaged integrations
-------------------------
Interoperability with pre-packaged integrations
------------------------------------------------

The following Mattermost-supported integrations are pre-packaged and available for your organization to configure and use:
The following Mattermost-supported integrations are pre-packaged and available for your Mattermost system admin to enable and configure for you to use:

- `GitHub <https://github.com/mattermost/mattermost-plugin-github/blob/master/README.md#installation>`__
- `GitLab <https://github.com/mattermost/mattermost-plugin-gitlab#readme>`__
- `Jira <https://github.com/mattermost/mattermost-plugin-jira#readme>`__
- `ServiceNow <https://github.com/mattermost/mattermost-plugin-servicenow>`__
- `Zoom <https://github.com/mattermost/mattermost-plugin-zoom/blob/master/README.md#installation>`__
- :ref:`AI Copilot <path/page>`
- :ref:`Export Mattermost channel data <integrate/export-mattermost-channel-data:usage>`
- :ref:`GitHub <integrate/github-interoperability:usage>`
- :ref:`GitLab <integrate/gitlab-interoperability:usage>`
- :ref:`Jira <integrate/jira-interoperability:usage>`
- :ref:`Microsoft Teams <integrate/ms-teams-interoperability:usage>`
- :ref:`Monitor performance metrics <integrate/monitor-performance-metrics:usage>`
- :ref:`Perform legal holds <integrate/perform-legal-holds:usage>`
- :ref:`ServiceNow <integrate/servicenow-interoperability:usage>`
- :ref:`Zoom <integrate/zoom-interoperability:usage>`

Latest integrations
-------------------
.. tip::

.. toctree::
:maxdepth: 1
:hidden:

Collaborate within connected MS Teams </collaborate/collaborate-within-connected-microsoft-teams>
Collaborate within embedded MS Teams </collaborate/collaborate-within-embedded-microsoft-teams>
Use the Mattermost Google Calendar plugin </collaborate/use-mattermost-google-calendar-plugin>

* :doc:`Collaborate within a Microsoft Teams instance </collaborate/collaborate-within-connected-microsoft-teams>` - Learn how to collaborate with colleagues when Mattermost is connected to Microsoft Teams.
* :doc:`Collaborate within an embedded Microsoft Teams instance </collaborate/collaborate-within-embedded-microsoft-teams>` - Learn how to collaborate with colleagues when Mattermost is embedded within Microsoft Teams.
* :doc:`Use the Mattermost Google Calendar plugin </collaborate/use-mattermost-google-calendar-plugin>` - Learn how to manage events using a two-way integration between Mattermost and Google Calendar.
`Visit the Mattermost Marketplace <https://mattermost.com/marketplace/>`__ to find open source, community-supported integrations to common developer tools like `CircleCI <https://mattermost.com/marketplace/circleci/>`__, `Opsgenie <https://mattermost.com/marketplace/opsgenie/>`__, `PagerDuty Notifier <https://mattermost.com/marketplace/pagerduty/>`__, and `Zendesk App <https://mattermost.com/marketplace/zendesk-app/>`__; productivity tools like `Autolink <https://mattermost.com/marketplace/autolink-plugin/>`__, `ToDo <https://mattermost.com/marketplace/todo/>`__, and `WelcomeBot <https://mattermost.com/marketplace/welcomebot-plugin/>`__; as well as social tools like `Memes <https://mattermost.com/marketplace/memes-plugin/>`__ and `GIFs <https://mattermost.com/marketplace/giphy-plugin/>`__ that are freely available for use and customization.
Loading
Loading