Skip to content

Commit

Permalink
Merge branch 'master' into amyblais-patch-13
Browse files Browse the repository at this point in the history
  • Loading branch information
amyblais authored Dec 15, 2023
2 parents ba1e1b4 + 8ed0324 commit ee260ab
Show file tree
Hide file tree
Showing 66 changed files with 821 additions and 388 deletions.
4 changes: 4 additions & 0 deletions Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ sphinx-autobuild = "==2021.3.14"
# Repo: https://github.com/executablebooks/sphinx-tabs
sphinx-tabs = "==3.4.0"
#
# Setuptools; used by sphinx-tabs
# Repo: https://github.com/pypa/setuptools
setuptools = "==68.2.2"
#
# Add a "copy" button to code blocks in Sphinx (https://sphinx-copybutton.readthedocs.io/en/latest/)
# Repo: https://github.com/executablebooks/sphinx-copybutton
sphinx-copybutton = "0.5.0"
Expand Down
267 changes: 147 additions & 120 deletions Pipfile.lock

Large diffs are not rendered by default.

12 changes: 12 additions & 0 deletions source/_static/badges/academy-channels.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
:orphan:
:nosearch:

.. raw:: html

<a href="https://mattermost.com/pl/mattermost-academy-channels-training" 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 channels</span>
</div>
</a>
2 changes: 1 addition & 1 deletion source/_static/badges/academy-file-storage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@
<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 file storage</span>
<span class="mm-badge__title">Learn about file storage</span>
</div>
</a>
2 changes: 1 addition & 1 deletion source/about/editions-and-offerings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Features include:
- `Granular system permissions </onboard/advanced-permissions.html>`__.
- Highly customizable `third-party bots, integrations <https://mattermost.com/marketplace/#publicApps>`__, and `command line tools </manage/mmctl-command-line-tool.html>`__.
- Extensive integration support via `webhooks, APIs, drivers <https://developers.mattermost.com/integrate/other-integrations/>`__, and `third-party extensions <https://mattermost.com/marketplace/>`__.
- Multiple languages including English (Australian, US), Bulgarian, Chinese (Simplified and Traditional), Dutch, French, German, Italian, Japanese, Korean, Persian, Polish, Portuguese (Brazil), Romanian, Russian, Spanish, Swedish, Turkish, and Ukrainian.
- Multiple languages including English (Australian, US), Bulgarian, Chinese (Simplified and Traditional), Dutch, French, German, Hungarian, Italian, Japanese, Korean, Persian, Polish, Portuguese (Brazil), Romanian, Russian, Spanish, Swedish, Turkish, Ukrainian, and Vietnamese.
- `Community support <https://mattermost.com/support/>`__.

See a complete list of features `here <https://mattermost.com/pricing>`__.
Expand Down
8 changes: 2 additions & 6 deletions source/about/embed-mattermost-app-within-microsoft-teams.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
Embed the Mattermost App within Microsoft Teams
================================================

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

.. tip::

Looking to `install the Mattermost for Microsoft Teams plugin </about/install-mattermost-for-microsoft-teams-plugin.html>`__ instead?

With `Mattermost for Microsoft Teams </about/mattermost-for-microsoft-teams.html>`__, you can embed your Mattermost workspace within your Microsoft Teams instance and take advantage of `embedded app features <#benefits-of-the-embedded-app>`_.
With the `Microsoft Teams plugin </about/mattermost-for-microsoft-teams.html>`__, you can embed your Mattermost workspace within your Microsoft Teams instance and take advantage of `embedded app features <#benefits-of-the-embedded-app>`_.

.. important::

Expand Down
12 changes: 6 additions & 6 deletions source/about/install-mattermost-for-microsoft-teams-plugin.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Install the Mattermost for Microsoft Teams plugin
=================================================

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

.. contents:: On this page
Expand All @@ -12,7 +12,7 @@ Install the Mattermost for Microsoft Teams plugin

Looking to `embed Mattermost within Microsoft Teams </about/embed-mattermost-within-microsoft-teams.html>`__ instead?

To install the `Mattermost for Microsoft Teams integration </configure/plugins-configuration-settings.html#ms-teams-sync>`__ in Mattermost:
To install the `Microsoft Teams plugin </configure/plugins-configuration-settings.html#ms-teams-sync>`__ 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-sync/releases>`__, compatible with Mattermost v8.0.1 and later. If you are using an earlier version of Mattermost, `follow our documentation </upgrade/upgrading-mattermost-server.html>`__ to upgrade to Mattermost v8.0.1 or later.
Expand Down Expand Up @@ -96,15 +96,15 @@ Step 2: 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 MS Teams on behalf of users who are present in Mattermost but not on MS Teams.
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.
3. This account is also needed when users on Mattermost have not connected their accounts and some messages need to be posted on their behalf. See the screenshot below:

.. image:: ../images/teams-user-as-bot.png
:alt: In Microsoft Teams, create a user account to act as a bot.

.. note::

After you've connected the bot user to the account on MS Teams, all the messages that are posted from the account on MS Teams won't be synchronized back to Mattermost since it's a "bot", and messages from bots are ignored.
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)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -129,7 +129,7 @@ Mattermost admins can configure Mattermost to automatically prompt users to conn
Configure the plugin
--------------------

Additional configuration settings are available for this plugin. See the `MS Teams Sync plugin configuration settings </configure/plugins-configuration-settings.html#ms-teams-sync>`__ documentation for details.
Additional configuration settings are available for this plugin. See the `Microsoft Teams Sync plugin configuration settings </configure/plugins-configuration-settings.html#ms-teams-sync>`__ documentation for details.

Monitor plugin performance
--------------------------
Expand All @@ -151,7 +151,7 @@ Grafana dashboards `are available on GitHub <https://github.com/mattermost/matte
Get started with the plugin
---------------------------

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

Trobleshooting
--------------
Expand Down
8 changes: 3 additions & 5 deletions source/about/mattermost-for-microsoft-teams.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
Mattermost for Microsoft Teams
==============================

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

Mattermost for Microsoft Teams enables you to collaborate with technical and operations teams seamlessly through the Mattermost app, without leaving Microsoft Teams. Two integrations are available: a `connected integration <#connect-mattermost-with-microsoft-teams>`__ and an `embedded integration <#embed-mattermost-within-mattermost-teams>`__.


The Mattermost for Microsoft Teams plugin enables you to collaborate with technical and operations teams seamlessly through the Mattermost app, without leaving Microsoft Teams. Two integrations are available: a `connected integration <#connect-mattermost-with-microsoft-teams>`__ and an `embedded integration <#embed-mattermost-within-mattermost-teams>`__.

.. include:: ../_static/badges/academy-msteams.rst
:start-after: :nosearch:
Expand All @@ -20,7 +18,7 @@ A connected Mattermost integration with Microsoft Teams enables direct message,

Install this integration by visiting the `install the Mattermost for Microsoft Teams plugin </about/install-mattermost-for-microsoft-teams-plugin.html>`__ documentation.

Visit the `collaborate within a connected Microsoft Teams instance </collaborate/collaborate-within-connected-microsoft-teams.html>`__ to learn how to use this integration.
Visit the `collaborate within a Microsoft Teams instance </collaborate/collaborate-within-connected-microsoft-teams.html>`__ to learn how to use this integration.

Embed Mattermost within Mattermost Teams
----------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion source/about/unified-collaboration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ 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 </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 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.
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
:orphan:
:nosearch:

Embed Mattermost within Microsoft Teams
=======================================
.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
Expand Down
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
Collaborate within connected Microsoft Teams
============================================
Collaborate within Microsoft Teams
==================================

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

.. |plus-icon| image:: ../images/plus_F0415.svg
:alt: Open menus using the plus icon.

The `Connected Mattermost for Microsoft Teams </about/mattermost-for-microsoft-teams.html>`__ integration enables you to collaborate with Microsoft Teams users without leaving Mattermost.
The `Mattermost for Microsoft Teams plugin </about/mattermost-for-microsoft-teams.html>`__ integration enables you to collaborate with Microsoft Teams users without leaving Mattermost.

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

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

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

1. Log into Mattermost using your credentials.
2. When you log in, you’ll be prompted to enter your Microsoft Teams user information, including your Microsoft Teams email address and your Microsoft Teams password.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
Collaborate within embedded Microsoft Teams
===========================================

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

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

Demonstration: Mattermost embedded in Microsoft Teams
------------------------------------------------------
Expand All @@ -13,4 +13,4 @@ Check out this `YouTube demo <https://youtu.be/Mg-stF7_Bjk>`__, from Doug Lauder

.. raw:: html

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

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

`Visit the Mattermost Marketplace <https://mattermost.com/marketplace/>`__ to find dozens of open source integrations to common tools like Jira, Jenkins, GitLab, with interactive bot applications (Hubot, mattermost-bot), and other communication tools (Email, IRC, XMPP, Threema) that are freely available for use and customization.

Latest integrations
Expand All @@ -17,7 +14,7 @@ Latest integrations
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 connected 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 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.

Expand Down Expand Up @@ -63,6 +60,4 @@ Video calling & screensharing
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- `Skype for Business <https://mattermost.com/marketplace/skype4business-plugin/>`__: Start and join voice calls, video calls, and use screensharing in Mattermost.
- `Zoom <https://mattermost.com/marketplace/zoom-plugin/>`__: Start audio and video conferencing calls in Mattermost.


- `Zoom <https://mattermost.com/marketplace/zoom-plugin/>`__: Start audio and video conferencing calls in Mattermost.
4 changes: 2 additions & 2 deletions source/collaborate/react-with-emojis-gifs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ Emojis and GIFs are small, digital images, animated images, or icons you can use
Quick emoji reactions
-----------------------

React to messages quickly with recently used emojis. Hover over a message to access recently used emojis.
Hover over a message to react quickly using your most recent emojis. You can react with up to 50 emojis per message.

.. image:: ../images/recent-emojis.png
:alt: React to messages quickly by selecting one of your most recently used emojis.

Recently used emojis are sorted based on how often you've used them.
Recently used emojis are sorted based on how often you've used them.

.. tip::

Expand Down
7 changes: 5 additions & 2 deletions source/comply/data-retention-policy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ By default, Mattermost stores all message history providing an unlimited search

In Mattermost Enterprise, you can set a global retention policy as well as custom retention policies to manage how long messages and file uploads are kept in Mattermost channels and direct messages.

For scheduled data retention jobs to work, the `global retention policy for files </configure/configuration-settings.html#enable-global-retention-policy-for-files>`__ as well as the `global retention policy for messages </configure/configuration-settings.html#enable-global-retention-policy-for-messages>`__ configuration settings in the ``config.json`` file must be set to ``true``. These configuration settings are disabled by default.

.. warning::
Once a message or a file is deleted, the action is irreversible. Please use caution when setting up global or custom data retention policies.

Expand Down Expand Up @@ -63,6 +61,11 @@ Replies that did not exceed the message duration are still displayed in the user

If there was a file attached to the message, it will be removed from the user interface only.

Why can I still see messages that were supposedly deleted?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The web and desktop app cache posts. Posts deleted by a data retention job will be visible to end users until they clear their cache and refresh.

What happens when a file is deleted by the file retention policy?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
18 changes: 16 additions & 2 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -1950,6 +1950,10 @@ def setup(_: Sphinx):
"developer/webhooks-incoming.html":
"https://developers.mattermost.com/integrate/admin-guide/admin-webhooks-incoming/",

# Microsoft Teams redirects
"about/embed-mattermost-within-microsoft-teams.html":
"about/embed-mattermost-app-within-microsoft-teams.html",

# Focalboard redirects
"focalboard/installing-boards":
"https://github.com/mattermost/focalboard/blob/main/docs/mattermost-boards-dev-guide.md",
Expand Down Expand Up @@ -2029,6 +2033,16 @@ def setup(_: Sphinx):
"https://docs.mattermost.com/guides/preferences.html",
"guides/welcome-to-mattermost.html#mattermost-interface-changes":
"https://docs.mattermost.com/guides/deployment.html#changelogs",
"guides/configure-app-framework.html":
"https://docs.mattermost.com/deploy/configure-app-framework",
"guides/deploy-http.html":
"https://docs.mattermost.com//deploy/deploy-http",
"guides/deploy-aws.html":
"https://docs.mattermost.com//deploy/deploy-aws",
"guides/package-aws.html":
"https://docs.mattermost.com//deploy/package-aws",
"guides/deploy-openfaas.html":
"https://docs.mattermost.com/deploy/deploy-openfaas",

# Help redirects resulting from the June 2021 docs reorganization project.
"help/apps/desktop-changelog.html":
Expand Down Expand Up @@ -3307,9 +3321,9 @@ def setup(_: Sphinx):
# built documents.
#
# The short X.Y version.
# version = '9.2'
# version = '9.3'
# The full version, including alpha/beta/rc tags.
# release = '9.2'
# release = '9.3'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
Loading

0 comments on commit ee260ab

Please sign in to comment.