Skip to content

Commit

Permalink
Merge branch 'master' into v9.9-documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
amyblais authored Jun 11, 2024
2 parents 4af9d00 + 6bfab1a commit 8a99330
Show file tree
Hide file tree
Showing 11 changed files with 58 additions and 39 deletions.
12 changes: 12 additions & 0 deletions source/_static/badges/academy-copilot-calls.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
:orphan:
:nosearch:

.. raw:: html

<a href="https://academy.mattermost.com/p/streamline-communication-with-mattermost-copilot-calls" class="mm-badge mm-badge--academy" target="_blank">
<img src="../_static/images/badges/academy-callout-image.jpg" alt="" />
<div class="mm-badge__copy">
<span class="mm-badge__accent-text">Mattermost Academy</span>
<span class="mm-badge__title">Learn about Mattermost Copilot and Calls</span>
</div>
</a>
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Chat with AI Copilot (Beta)
===========================
Chat with Copilot (Beta)
=========================

.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
:start-after: :nosearch:
Expand All @@ -8,26 +8,29 @@ Chat with AI Copilot (Beta)
: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.
Overcome information overload and streamline communication and collaboration by chatting with Mattermost 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.
Copilot must be :doc:`enabled and configured </configure/enable-copilot>` by a Mattermost system admin in the System Console before you can start using it.

.. include:: ../_static/badges/academy-copilot-calls.rst
:start-after: :nosearch:

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.
Select the **Copilot** icon in the apps bar located to the far right of the Mattermost screen to open the 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.
:alt: Privately chat with 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.
Begin with suggested prompts, or engage in a private thread with the Copilot bot for a tailored experience. If you have follow-up questions or need further insights, simply ask! 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.
Copilot remembers the context for follow-on questions and requests. Access all previous conversations by selecting **View chat history**. from the Copilot pane.

With AI Copilot you can perform the following tasks:
With Copilot you can perform the following tasks:

- Summarize your call recordings
- Turn long threads & unread channel messages into concise summarizes
Expand All @@ -54,7 +57,7 @@ To summarize a Mattermost call recording:

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
.. image:: ../images/copilot-Calls-Meeting-Summary.png
: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

Expand All @@ -66,30 +69,30 @@ Summarize threads & unread channel messages

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.
Ensure you stay on top of communications across threads, channels, and teams, by using 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.
2. The thread summary is generated in the 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.
2. The channel summary is generated in the 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.
.. image:: ../images/Unread-Channel-Messages-Summarization-Updated-4-3.gif
:alt: Quickly summarize new messages, find action opens, and seek out unanswered questions with your Copilot.

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

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

Bring AI Copilot into any conversation
Bring 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.
Invoke the power of AI by @mentioning the Copilot bot (@copilot) 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.
.. image:: ../images/Contextual-Interrogation-Updated-4-3.gif
:alt: Bring your AI into the conversation. @mention your Copilot directly within any thread and use the context to work faster and smarter.
2 changes: 1 addition & 1 deletion source/collaborate/extend-mattermost-with-integrations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The following pre-packaged feature & interoperability integrations are available
Mattermost features
~~~~~~~~~~~~~~~~~~~~

- :ref:`AI Copilot <collaborate/chat-with-ai-copilot:get started>`
- :ref:`Copilot <collaborate/chat-with-ai-copilot:get started>`
- :ref:`Export Mattermost channel data <comply/export-mattermost-channel-data:usage>`
- :ref:`Monitor performance metrics <scale/collect-performance-metrics:usage>`
- :doc:`Perform legal holds </comply/legal-hold>`
Expand Down
4 changes: 4 additions & 0 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -830,6 +830,8 @@ def setup(_: Sphinx):
"https://docs.mattermost.com/collaborate/collaborate-within-connected-microsoft-teams.html",
"collaborate/use-mattermost-google-calendar-plugin.html":
"https://github.com/mattermost/mattermost-plugin-google-calendar/blob/master/README.md",
"collaborate/chat-with-ai-copilot.html":
"https://docs.mattermost.com/collaborate/chat-with-copilot.html",

# Compliance redirects
"comply/compliance-reporting-oversight":
Expand All @@ -844,6 +846,8 @@ def setup(_: Sphinx):
"https://forum.mattermost.org/t/configuring-apache2-with-ssl-and-http-2/11939",
"configure/configuring-apache2.html":
"https://forum.mattermost.com/t/configuring-apache2-as-a-proxy-for-mattermost-server/11938",
"configure/enable-ai-copilot.html":
"https://docs.mattermost.com/enable-copilot.html",

# Configuration settings redirects
"configure/configuration-in-mattermost-database.html":
Expand Down
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
Enable AI Copilot (Beta)
========================
Enable Copilot (Beta)
=======================

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

Signficantly increase team productivity and decision-making speed by enhancing your real-time collaboration capabilities with instant access to AI-generated information, discussion summaries, and contextually-aware action recommendations with Mattermost's AI Copilot. Your users can interact with AI capabilities directly within their daily communication channels without needing to switch between multiple tools or platforms
Signficantly increase team productivity and decision-making speed by enhancing your real-time collaboration capabilities with instant access to AI-generated information, discussion summaries, and contextually-aware action recommendations with Mattermost's Copilot. Your users can interact with AI capabilities directly within their daily communication channels without needing to switch between multiple tools or platforms

Setup
------

Mattermost AI Copilot comes preinstalled from Mattermost Server v9.7 or later. You need to be a Mattermost system admin to `enable it <#enable>`__ and `configure it <#mattermost-configuration>`__ using the System Console.
Mattermost Copilot comes preinstalled from Mattermost Server v9.7 or later. You need to be a Mattermost system admin to `enable it <#enable>`__ and `configure it <#mattermost-configuration>`__ using the System Console.

.. note::
If you're running Mattermost Server v9.6 or earlier, AI Copilot must be installed using the `latest binary available for download from the plugin repository <https://github.com/mattermost/mattermost-plugin-ai/releases>`_ . For an optimized user experience and compatibility, we recommend using AI Copilot with Mattermost v9.7 and later.
If you're running Mattermost Server v9.6 or earlier, Copilot must be installed using the `latest binary available for download from the plugin repository <https://github.com/mattermost/mattermost-plugin-ai/releases>`_ . For an optimized user experience and compatibility, we recommend using Copilot with Mattermost v9.7 and later.

The AI Copilot integration is compatible with the following :doc:`Mattermost Server versions </deploy/mattermost-changelog>`:
The Copilot integration is compatible with the following :doc:`Mattermost Server versions </deploy/mattermost-changelog>`:

- v9.6 or later
- v9.5.2+ (Extended Support Release - ESR)
Expand All @@ -25,16 +25,16 @@ Mattermost AI Copilot comes preinstalled from Mattermost Server v9.7 or later. Y
Enable
------

Go to **System Console > Plugins > AI Copilot** to enable this feature.
Go to **System Console > Plugins > Copilot** to enable this feature.

Once the integration is installed and enabled, complete configuration in the System Console as described below, then notify your teams that they can use the AI Copilot in any Mattermost team or channel.
Once the integration is installed and enabled, complete configuration in the System Console as described below, then notify your teams that they can use the Copilot in any Mattermost team or channel.

Mattermost configuration
~~~~~~~~~~~~~~~~~~~~~~~~

With extensive customization and extensibility options, you can tailor your AI Copilot to meet your specific needs, whether it's integrating with internal systems, customizing AI responses based on the team or project needs, or developing new capabilities that are unique to your operational requirements. You can also create custom integrations, workflows, and bots that leverage AI to meet your unique business needs.
With extensive customization and extensibility options, you can tailor Copilot to meet your specific needs, whether it's integrating with internal systems, customizing AI responses based on the team or project needs, or developing new capabilities that are unique to your operational requirements. You can also create custom integrations, workflows, and bots that leverage AI to meet your unique business needs.

Configure a large language model (LLM) for your AI Copilot integration by going to **System Console > Plugins > AI Copilot**. Mattermost supports the following LLMs:
Configure a large language model (LLM) for your Copilot integration by going to **System Console > Plugins > Copilot**. Mattermost supports the following LLMs:

- `OpenAI <https://platform.openai.com/account/api-keys>`_
- `Anthropic (Claude) <https://console.anthropic.com/account/keys>`_
Expand Down Expand Up @@ -88,4 +88,4 @@ Visit the `Releases page <https://github.com/mattermost/mattermost-plugin-ai/rel
Usage
-----

See the :doc:`chat with AI Copilot </collaborate/chat-with-ai-copilot>` documentation for details on using AI Copilot to Overcome information overload and streamline communication and collaboration.
See the :doc:`chat with Copilot </collaborate/chat-with-copilot>` documentation for details on using Copilot to overcome information overload and streamline communication and collaboration.
4 changes: 2 additions & 2 deletions source/guides/collaborate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This Mattermost end user documentation is designed for anyone who wants guidance
Learn about Mattermost roles </collaborate/learn-about-roles>
Collaborate within channels </collaborate/collaborate-within-channels>
Collaborate within Microsoft Teams </collaborate/collaborate-within-connected-microsoft-teams>
Chat with AI Copilot </collaborate/chat-with-ai-copilot>
Chat with Copilot </collaborate/chat-with-copilot>
Communicate with messages and threads </collaborate/communicate-with-messages>
Keyboard shortcuts </collaborate/keyboard-shortcuts>
Extend Mattermost with integrations </collaborate/extend-mattermost-with-integrations>
Expand All @@ -35,7 +35,7 @@ This Mattermost end user documentation is designed for anyone who wants guidance
* :doc:`Learn about Mattermost user roles </collaborate/learn-about-roles>` - Learn about the 6 user roles in Mattermost and what they can do.
* :doc:`Collaborate within channels </collaborate/collaborate-within-channels>` - Learn how to get started collaborating within Mattermost channels.
* :doc:`Collaborate within Microsoft Teams </collaborate/collaborate-within-connected-microsoft-teams>` - Learn how to get started collaborating within Microsoft Teams.
* :doc:`Chat with AI Copilot </collaborate/chat-with-ai-copilot>` - Overcome information overload and streamline communication and collaboration by chatting with the Mattermost AI Copilot in your Mattermost instance.
* :doc:`Chat with Copilot </collaborate/chat-with-copilot>` - Overcome information overload and streamline communication and collaboration by chatting with Copilot in your Mattermost instance.
* :doc:`Communicate with messages and threads </collaborate/communicate-with-messages>` Learn how to get started collaborating within Mattermost channels.
* :doc:`Keyboard shortcuts </collaborate/keyboard-shortcuts>` - Make a more efficient use of your keyboard with keyboard shortcuts.
* :doc:`Extend Mattermost with integrations </collaborate/extend-mattermost-with-integrations>` - Find open source integrations to common tools in the Mattermost Marketplace.
6 changes: 3 additions & 3 deletions source/guides/get-started-with-administration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Get started with administration
Site configuration settings </configure/site-configuration-settings>
Authentication configuration settings </configure/authentication-configuration-settings>
Plugins configuration settings </configure/plugins-configuration-settings>
Enable AI Copilot </configure/enable-ai-copilot>
Enable Copilot </configure/enable-copilot>
Integrations configuration settings </configure/integrations-configuration-settings>
Compliance configuration settings </configure/compliance-configuration-settings>
Experimental configuration settings </configure/experimental-configuration-settings>
Expand Down Expand Up @@ -48,7 +48,7 @@ These resources will help you get started with your Mattermost self-hosted or Cl
* **Mattermost feature labels** - Learn what :doc:`Mattermost feature labels </getting-started/feature-labels>`, including :ref:`Experimental <getting-started/feature-labels:experimental>`, :ref:`Beta <getting-started/feature-labels:beta>`, :ref:`General Availability <getting-started/feature-labels:general availability>`, and :ref:`Deprecated <getting-started/feature-labels:deprecated>` mean to the status, maturity, and support level of Mattermost product features and functionality in your Mattermost deployment.
* **Optimize your workspace** - Review health and growth scores for your Mattermost workspace, and take necessary action using the :doc:`workspace optimization </configure/optimize-your-workspace>` page in the System Console.
* **Configure your workspace** - Mattermost offers extensive configuration options for both :doc:`self-hosted Mattermost servers and Mattermost Cloud workspaces </configure/configuration-settings>`, and provides a list of :doc:`deprecated configuration settings </configure/deprecated-configuration-settings>` no longer supported.
* **Enable AI Copilot** - Learn how to enable AI Copilot in Mattermost </configure/enable-ai-copilot>`
* **Enable Copilot** - Learn how to :doc:`enable Copilot in Mattermost </configure/enable-copilot>`
* **Environment variables** - Learn how to use :doc:`environment variables </configure/environment-variables>` to manage configuration for a self-hosted deployment.
* **Provisioning workflows** - Learn how to :doc:`provision </onboard/user-provisioning-workflows>` and de-provision user accounts.
* **User authentication** - All versions of Mattermost provide basic authentication and offer :doc:`multi-factor authentication </onboard/multi-factor-authentication>` out of the box. Professional and Enterprise versions of Mattermost also include :doc:`Active Directory/LDAP </onboard/ad-ldap>` and SSO for :doc:`GitLab SSO </onboard/sso-gitlab>`, :doc:`OpenID </onboard/sso-openidconnect>`, :doc:`Google </onboard/sso-google>`, and :doc:`Office365 </onboard/sso-office>`.
Expand Down Expand Up @@ -98,4 +98,4 @@ Advanced workspace management
* :doc:`User satisfaction surveys </manage/user-satisfaction-surveys>` - Learn about Mattermost user satisfaction surveys and how to configure their operation.
* :doc:`Health check </manage/health-checks>` - Configure health probes for your Mattermost server.
* :doc:`Announcement banner </manage/announcement-banner>` - Display notices to your users via an announcement banner.
* :doc:`Bulk export tool </manage/bulk-export-tool>` - Export user, team, channel, and post data from Mattermost.
* :doc:`Bulk export tool </manage/bulk-export-tool>` - Export user, team, channel, and post data from Mattermost.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/copilot-Calls-Meeting-Summary.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/images/create-meeting-summary.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8a99330

Please sign in to comment.