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 26 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
4 changes: 2 additions & 2 deletions 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 All @@ -311,7 +311,7 @@ <h4>Contribute</h4>
</div>
<div class='masthead-card__content'>
<h4>Integrate and extend</h4>
<p>Extend Mattermost capabilities via Apps, Plugins, Webhooks, or APIs.</p>
<p>Extend Mattermost capabilities with pre-packaged feature & interoperability integrations.</p>
<p class='link'>Get started »</p>
</div>
</a>
Expand Down
7 changes: 4 additions & 3 deletions source/about/editions-and-offerings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,13 +114,14 @@ This offering includes all the features of Mattermost Professional, plus:
- :doc:`Enhanced compliance with global and custom retention policies for messages and files </comply/data-retention-policy>`.
- :doc:`Playbooks with ad hoc add/remove tasks, automated triggers, and stakeholders dashboard </repeatable-processes/learn-about-playbooks>`.
- :doc:`Granular administrative control with custom system admin roles </onboard/system-admin-roles>`.
- :doc:`Advanced configuration of playbook permissions, analytics dashboards, and channel exports </repeatable-processes/share-and-collaborate>`.
- :doc:`Advanced configuration of playbook permissions, and analytics dashboards </repeatable-processes/share-and-collaborate>`
- :doc:`Channel export </comply/export-mattermost-channel-data>`
- :ref:`Enhanced compliance controls and granular audit logs with data export <manage/logging:audit logging (beta)>`.
- :doc:`Advanced collaboration with shared channels across Mattermost instances </onboard/shared-channels>`.
- :doc:`High availability support with multi-node database deployment </scale/high-availability-cluster>`.
- :doc:`Horizontal scaling through cluster-based deployment </scale/scaling-for-enterprise>`.
- :doc:`Advanced performance monitoring </scale/performance-monitoring>`.
- `Eligibility for Premier Support add-on <https://mattermost.com/support/>`_.
- :doc:`Advanced performance monitoring </scale/deploy-prometheus-grafana-for-performance-monitoring>`.
- `Eligibility for Premier Support add-on <https://mattermost.com/support/>`__.
- 99% uptime SLA guarantee (Cloud only, via dedicated virtual secure Cloud add-on option).

Other Mattermost plans
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/deploy-prometheus-grafana-for-performance-monitoring>` and :doc:`performance alerting </scale/performance-alerting>` for this plugin 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.
1 change: 0 additions & 1 deletion source/about/unified-collaboration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,5 @@ Unified communication
Mattermost's Unified Communication solution is designed to provide an extended collaboration experience for technical and operational teams to teams on other collaboration systems.

* :doc:`Mattermost for Microsoft Teams plugin</about/mattermost-for-microsoft-teams>` - Learn how organizations can easily connect operational workflows through the Mattermost app while staying connected to the all-employee platform, all in one place.
* :doc:`Mattermost Google Calendar integration </about/mattermost-google-calendar-integration>` - Learn how to enable a two-way integration between Mattermost and Google Calendar.

`Contact us <https://mattermost.com/contact-sales/>`_ to learn more about this solution and to discuss whether it’s the right one for you.
4 changes: 1 addition & 3 deletions source/about/use-cases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,11 @@ Use cases
:titlesonly:

/about/secure-command-and-control.rst
/about/unified-collaboration.rst
/about/devops-collaboration.rst
/about/incident-response-collaboration.rst

Learn more about how to use Mattermost in agile software development, incident response, customer onboarding, and many other applications.

* :doc:`Secure command and control </about/secure-command-and-control>` - Learn about the Mattermost Secure Command and Control solution, designed to provide fast and secure mobile communications for technical teams.
* :doc:`Unified collaboration </about/unified-collaboration>` - Learn how Central IT organizations can provide an extended customization experience for technical and operational teams across both Mattermost and the Microsoft 365 all-employee platform.
* :doc:`How to: Build your Agile software development practice </about/devops-collaboration>` - Learn how to accelerate software development and deployment processes and reduce costs.
* :doc:`How to: Respond to incidents and outages quickly and effectively </about/incident-response-collaboration>` - Maximize your Mattermost deployment with incident response collaboration.
* :doc:`How to: Respond to incidents and outages quickly and effectively </about/incident-response-collaboration>` - Maximize your Mattermost deployment with incident response collaboration.
95 changes: 95 additions & 0 deletions source/collaborate/chat-with-ai-copilot.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
Chat with AI Copilot (Beta)
===========================

.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
:start-after: :nosearch:

.. |ai-actions-icon| image:: ../images/creation-outline_F1C2B.svg
:alt: Select the AI Actions icon to access AI options.
:class: theme-icon

Overcome information overload and streamline communication and collaboration by chatting with the Mattermost AI Copilot in your Mattermost instance.

.. note::

AI Copilot must be :doc:`enabled and configured </configure/enable-ai-copilot>` by a Mattermost system admin in the System Console before you can start using it.

Get started
~~~~~~~~~~~

Select the **AI Copilot** icon in the apps bar located to the far right of the Mattermost screen to open the AI Copilot tab in the right pane.

.. image:: ../images/copilot-AI-RHS.webp
:alt: Privately chat with your AI Copilot inside Mattermost via the right-hand sidebar.
:scale: 50

Begin with suggested prompts, or engage in a private thread with the AI Copilot bot for a tailored experience. If you have follow-up questions or need further insights, simply ask! AI Copilot is designed to provide deeper understanding based on your inquiries.

AI Copilot remembers the context for follow-on questions and requests. Access all previous AI conversations by selecting **View chat history**. from the AI Copilot pane.

With AI Copilot you can perform the following tasks:

- Summarize your call recordings
- Turn long threads & unread channel messages into concise summarizes
- Stay on top of all of your commucations by identifying next steps, decisions made, and pinpointing unanswered questions
- Extract learnings and transform content into charts, resources, documentation, articles, and more
- Dig further into any topic that's on your mind

Summarize Mattermost call recordings
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. include:: ../_static/badges/ent-only.rst
:start-after: :nosearch:

Leverage Mattermost Calls to turn meeting recordings into actionable summaries with a single click. Ensure key points are captured and shared easily, and enable easy sharing of meeting insights with your team and the broader organization, enhancing communication and productivity.

To summarize a Mattermost call recording:

1. :ref:`Start a call in Mattermost <collaborate/make-calls:start a call>`.
2. :ref:`Record the call <collaborate/make-calls:record a call>`.
3. Once the call ends, and the call recording and transcription is ready, select the **Create meeting summary** option located directly above the call recording.

.. image:: ../images/create-meeting-summary.png
:alt: Select the Create meeting summary option to summarize your call recording in Mattermost.

4. The meeting summary is generated and shared as a direct message with the person who requested the meeting summary.

.. image:: ../images/copilot-Calls-Meeting-Summary.webp
:alt: Easily share the updates from your Mattermost Calls with your team and broader organization by turning recordings into detailed summaries at the click of a button.
:scale: 50

Summarize threads & unread channel messages
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. include:: ../_static/badges/ent-only.rst
:start-after: :nosearch:

Accelerate decision-making and improve information flows with concise summaries of long discussions delivered to you directly through direct messages.

Ensure you stay on top of communications across threads, channels, and teams, by using AI Copilot to summarize new messages, identify next steps, and pinpoint unanswered questions.

To summarize Mattermost threads:

1. Hover over the first message in any conversation thread, select the **AI Actions** |ai-actions-icon| icon, and select **Summarize Thread**.
2. The thread summary is generated in the AI Copilot pane, and only you can view the summary.

To summarize unread Mattermost channels:

1. In a channel with unread messages, scroll to the **New Messages** cutoff, select **Ask AI**, and then select **Summarize new messages**.
2. The channel summary is generated in the AI Copilot pane, and only you can view the summary.

.. image:: ../images/copilot-Unread-Channel-Messages-Summarization.webp
:alt: Quickly summarize new messages, find action opens, and seek out unanswered questions with your AI Copilot.

Chat privately with the AI bot
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also chat privately with your AI Copilot in direct message threads like you would any other Mattermost user.

Bring AI Copilot into any conversation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Invoke the power of AI by @mentioning your AI bot in any thread to bring AI's capabilities to your conversation, allowing for quick extraction of information or transformation of discussions into charts, resources, documentation, articles, and more. With the power of Mattermost integrations and interoperability, the potential to enhance your workflow is limitless.

.. image:: ../images/copilot-Contextual-Interrogation.webp
:alt: Bring your AI into the conversation. @ mention your AI Copilot directly within any thread and use the context to work faster and smarter.
Loading
Loading