Skip to content

Commit

Permalink
Merge branch 'master' into health-check
Browse files Browse the repository at this point in the history
  • Loading branch information
cwarnermm authored Sep 12, 2024
2 parents e5b6b5b + a5e85e1 commit a9b545d
Show file tree
Hide file tree
Showing 73 changed files with 263 additions and 517 deletions.
12 changes: 6 additions & 6 deletions source/collaborate/access-your-workspace.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Email address or username

When :ref:`account creation with email <configure/authentication-configuration-settings:enable account creation with email>` is enabled by your system admin, you can log in with the username or email address used to create a Mattermost account.

.. image:: ../images/sign-in_with_email.png
.. image:: ../images/login-email-username.png
:alt: Log in to Mattermost with your username or email address, or reset your password.

Single Sign-On (SSO)
Expand All @@ -77,14 +77,14 @@ When enabled by your system admin, you may log in using your GitLab, Google, Ent

When enabled by your system admin, you can log in with your GitLab account using a one-click login option.

.. image:: ../images/sign-in-gitlab.png
.. image:: ../images/login-gitlab.png
:alt: Log in to Mattermost using your GitLab credentials.

.. tab:: Google

When enabled by your system admin, you can log in with your Google account using a one-click login option.

.. image:: ../images/sign-in-google-apps.png
.. image:: ../images/login-google.png
:alt: Log in to Mattermost using your Google Apps credentials.

.. tab:: Entra ID
Expand All @@ -99,7 +99,7 @@ When enabled by your system admin, you may log in using your GitLab, Google, Ent

When enabled by your system admin, you can log in with your AD/LDAP credentials. This lets you use the same username and password for Mattermost that you use for various other company services.

.. image:: ../images/sign-in_with_ldap.png
.. image:: ../images/login-ad.png
:alt: Log in to Mattermost with your AD/LDAP credentials.

.. tab:: SAML
Expand All @@ -108,8 +108,8 @@ When enabled by your system admin, you may log in using your GitLab, Google, Ent

Mattermost officially supports :doc:`Okta </onboard/sso-saml-okta>`, :doc:`OneLogin </onboard/sso-saml-onelogin>`, and Microsoft ADFS as an identity provider (IDP) for SAML, but you may use other SAML IDPs as well. See our :doc:`SAML Single Sign-On documentation </onboard/sso-saml>` to learn more about configuring SAML for Mattermost.

.. image:: ../images/sign-in_with_saml.png
:alt: Log in to Mattermost with your SAML credentials.
.. image:: ../images/login-onelogin.png
:alt: Log in to Mattermost with SAML credentials, such as OneLogin.

Multi-factor authentication
---------------------------
Expand Down
4 changes: 0 additions & 4 deletions source/collaborate/archive-unarchive-channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ Archive and unarchive channels
.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
:start-after: :nosearch:

.. |more-icon| image:: ../images/dots-horizontal_F01D8.svg
:alt: Use the More icon to access additional message options.
:class: theme-icon

Archive a channel
-----------------

Expand Down
8 changes: 2 additions & 6 deletions source/collaborate/browse-channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,9 @@ Browse channels
.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
:start-after: :nosearch:

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

.. tab:: Web/Desktop

1. Select the **Plus** |plus-icon| icon at the top of the channel sidebar to see all available public channels you can join that you're not already a member of.
1. Select the **Plus** |plus| icon at the top of the channel sidebar to see all available public channels you can join that you're not already a member of.
2. Select **Browse Channels**.
3. Search for channels by name or scroll through the list.
4. Select **Join** next to any channel to become a member of that channel.
Expand All @@ -21,7 +17,7 @@ Browse channels

.. tab:: Mobile

1. Tap the **Plus** |plus-icon| icon located in the top right corner of the app to see all available public channels you can join that you're not already a member of.
1. Tap the **Plus** |plus| icon located in the top right corner of the app to see all available public channels you can join that you're not already a member of.
2. Tap **Browse Channels**.
3. Search for channels by name or filter the list of channels to show only public or archived channels.
4. Tap a channel to become a member of that channel.
Expand Down
3 changes: 0 additions & 3 deletions source/collaborate/channel-header-purpose.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ Communicate a channel's focus and scope
.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
:start-after: :nosearch:

.. |channel-info| image:: ../images/information-outline_F02FD.svg
:alt: Use the Channel Info icon to access additional channel management options.
:class: theme-icon

Every channel in Mattermost serves a purpose and exists for a reason. You can communicate a channel's focus and scope in 3 ways:

Expand Down
12 changes: 2 additions & 10 deletions source/collaborate/channel-types.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,21 @@ Channel types
.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
:start-after: :nosearch:

.. |globe-icon| image:: ../images/globe_E805.svg
:alt: A globe icon indicates a public channel.
:class: theme-icon

.. |lock-icon| image:: ../images/lock-outline_F0341.svg
:alt: A lock icon indicates a private channel.
:class: theme-icon

Channels are used to organize conversations across different topics. Find available channels in the left-hand panel. There are four types of channels: public channels, private channels, direct messages, and group messages. Enterprise system administrators can also configure channels as :ref:`read-only <onboard/advanced-permissions:read only channels>`.

Sending messages, replying to messages, and participating in conversation threads are important ways to keep conversations active with your team. See the following topics to learn more about working with channels.

Public channels
---------------

Public channels are open to everyone on a team and are identified with a **Globe** |globe-icon| icon. New team members are automatically added to two public channels when they sign up: **Town Square** and **Off-Topic**.
Public channels are open to everyone on a team and are identified with a **Globe** |globe| icon. New team members are automatically added to two public channels when they sign up: **Town Square** and **Off-Topic**.

See the :doc:`Join and leave channels </collaborate/join-leave-channels>` documentation for details on discovering and joining other channels.

Private channels
----------------

Private channels are for sensitive topics and are only visible to selected team members. Private channels are identified with a **Lock** |lock-icon| icon. In Team Edition, any member of a private channel can add or remove other members from private channels, but in other Mattermost versions these permissions can be restricted to the channel admins and system admins.
Private channels are for sensitive topics and are only visible to selected team members. Private channels are identified with a **Lock** |lock| icon. In Team Edition, any member of a private channel can add or remove other members from private channels, but in other Mattermost versions these permissions can be restricted to the channel admins and system admins.

Channel members can choose to leave private channels at any time.

Expand Down
4 changes: 0 additions & 4 deletions source/collaborate/chat-with-copilot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ Chat with 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 Mattermost Copilot in your Mattermost instance.

.. note::
Expand Down
12 changes: 0 additions & 12 deletions source/collaborate/collaborate-within-channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,6 @@ Collaborate within channels
.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
:start-after: :nosearch:

.. |globe| image:: ../images/globe_E805.svg
:alt: Public channels are identified with a Globe icon.
:class: theme-icon

.. |lock| image:: ../images/lock-outline_F0341.svg
:alt: Private channels are identified with a Lock icon.
:class: theme-icon

.. |plus| image:: ../images/plus_F0415.svg
:alt: The Plus icon provides access to channel and direct message functionality.
:class: theme-icon

Channels are where you connect, collaborate, and communicate with your team about various topics or projects. Use channels to organize conversations across different topics. :doc:`Sending messages </collaborate/send-messages>`, :doc:`replying to messages </collaborate/reply-to-messages>`, and :ref:`participating in conversation threads <collaborate/organize-conversations:start or reply to threads>` are important ways to keep conversations active with your team.

You're added to default channels automatically
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ Collaborate within Microsoft Teams
.. include:: ../_static/badges/ent-cloud-selfhosted.rst
:start-after: :nosearch:

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

The Mattermost for Microsoft Teams integration enables you to break through siloes in a mixed Mattermost and Teams environment by forwarding real-time chat notifications from Teams to Mattermost.

.. image:: ../images/microsoft-teams-chat-notifications.gif
Expand Down Expand Up @@ -68,5 +64,5 @@ Chat notifications are sent in real-time whenever you're not active in Microsoft
- Web browser: Mattermost delivers notifications when you've not had activity in your Microsoft Teams browser tab for 5 minutes or more, or when the browser tab is closed.
- Desktop app: Mattermost delivers notifications when you've not had activity at your computer for 5 minutes or more, or when the Microsoft Teams desktop app is closed.

In order to avoid double notifications, Mattermost won't deliver chat notifications when your :ref:`Mattermost availability <preferences/set-your-status-availability:set your availability>` is set to **Available**, **Busy**, **Do not disturb**, or **Be right back** in Microsoft Teams.
In order to avoid double notifications, Mattermost won't deliver chat notifications when your availability is set to **Available**, **Busy**, **Do not disturb**, or **Be right back** in Microsoft Teams.

4 changes: 0 additions & 4 deletions source/collaborate/convert-group-messages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ Convert group messages to private channels
.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
:start-after: :nosearch:

.. |more-icon| image:: ../images/dots-horizontal_F01D8.svg
:alt: Use the More icon to access additional message options.
:class: theme-icon

From Mattermost v9.1, you can change the members of your group conversation by converting the group message to a private channel. When a group message is converted to private, its history and membership are preserved. Membership in a private channel remains as invitation only.

.. note::
Expand Down
4 changes: 0 additions & 4 deletions source/collaborate/convert-public-channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ Convert public channels to private channels
.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
:start-after: :nosearch:

.. |more-icon| image:: ../images/dots-horizontal_F01D8.svg
:alt: Use the More icon to access additional message options.
:class: theme-icon

You must be a system admin or team admin to convert public channels to private channels. When a channel is converted from public to private, its history and membership are preserved. Membership in a private channel remains as invitation only. Publicly-shared files remain accessible to anyone with the link.

.. note::
Expand Down
14 changes: 5 additions & 9 deletions source/collaborate/create-channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,13 @@ Create channels
.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
:start-after: :nosearch:

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

Anyone can create public channels, private channels, direct messages, and group messages unless the system admin has :doc:`restricted permissions to do so using advanced permissions </onboard/advanced-permissions>`. Enterprise system administrators can also configure channels as :ref:`read-only <onboard/advanced-permissions:read only channels>`.

.. tab:: Web/Desktop

**To create a public or private channel**

1. Select the **Add channels** button in the channel sidebar, then select **Create New Channel**. Alternatively, you can select |plus-icon| at the top of the channel sidebar, then select **Create New Channel**.
1. Select the **Add channels** button in the channel sidebar, then select **Create New Channel**. Alternatively, you can select |plus| at the top of the channel sidebar, then select **Create New Channel**.

.. image:: ../images/add-channels-button.png
:alt: You can create a channel using the Add channels button
Expand All @@ -26,7 +22,7 @@ Anyone can create public channels, private channels, direct messages, and group

**To start a direct or group message**

1. Select the |plus-icon| next to the **Direct Messages** category in the channel sidebar.
1. Select the |plus| next to the **Direct Messages** category in the channel sidebar.

.. image:: ../images/write-dm.png
:alt: Access recent direct messages and group messages.
Expand All @@ -35,7 +31,7 @@ Anyone can create public channels, private channels, direct messages, and group

.. tip::

- Alternatively, select |plus-icon| at the top of the channel sidebar, then select **Open a Direct Message**. In the **Direct Messages** list, you'll see your most recent conversations.
- Alternatively, select |plus| at the top of the channel sidebar, then select **Open a Direct Message**. In the **Direct Messages** list, you'll see your most recent conversations.
- To add more people to the conversation select the channel name, then select **Add Members**. Adding members to a group message creates a new channel and starts a new conversation.
- You can't remove members of a group message; however, you can start a new group channel and conversation with different members.
- If you want to add more than 7 users to a group message, create a private channel instead.
Expand All @@ -44,11 +40,11 @@ Anyone can create public channels, private channels, direct messages, and group

**To create a public or private channel**

Tap |plus-icon| in the top right corner of the app, then select **Create New Channel**. Channels are created as public by default. If you want to create a private channel, tap the **Make Private** option.
Tap |plus| in the top right corner of the app, then select **Create New Channel**. Channels are created as public by default. If you want to create a private channel, tap the **Make Private** option.

**To start a direct or group message**

Tap |plus-icon| in the top right corner of the app, then select **Open a Direct Message**. You can select one person for a direct message or up to seven people for a group message. Tap **Start** to start the conversation.
Tap |plus| in the top right corner of the app, then select **Open a Direct Message**. You can select one person for a direct message or up to seven people for a group message. Tap **Start** to start the conversation.

Automate with channel actions
-----------------------------
Expand Down
12 changes: 0 additions & 12 deletions source/collaborate/favorite-channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,6 @@ Mark channels as favorites
.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
:start-after: :nosearch:

.. |more-icon| image:: ../images/dots-horizontal_F01D8.svg
:alt: Use the More icon to access additional message options.
:class: theme-icon

.. |channel-info| image:: ../images/information-outline_F02FD.svg
:alt: Use the Channel Info icon to access additional channel management options.
:class: theme-icon

.. |favorite-icon| image:: ../images/star-outline_F04D2.svg
:alt: Use the Star icon to mark a channel as a favorite.
:class: theme-icon

You can mark public and private channels, as well as direct and group messages as favorites so they're easy to access later. Favorite channels display in the **Favorites** category in the channel sidebar.

.. image:: ../images/favorites-list-sidebar.png
Expand Down
62 changes: 1 addition & 61 deletions source/collaborate/format-messages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,66 +4,6 @@ Format messages
.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
:start-after: :nosearch:

.. |bold-icon| image:: ../images/format-bold_F0264.svg
:alt: Bold message text using the Bold icon in the message formatting toolbar.
:class: theme-icon

.. |italics-icon| image:: ../images/format-italic_F0277.svg
:alt: Italicize message text using the Italic icon in the message formatting toolbar.
:class: theme-icon

.. |strikeout-icon| image:: ../images/format-strikethrough-variant_F0281.svg
:alt: Strike out message text using the Strikethrough icon in the message formatting toolbar.
:class: theme-icon

.. |headings-icon| image:: ../images/format-header_E81D.svg
:alt: Format message text as a heading using the Heading icon in the message formatting toolbar. Headings 1 through 6 are supported.
:class: theme-icon

.. |links-icon| image:: ../images/link-variant_F0339.svg
:alt: Add a message link using the Link icon in the message formatting toolbar.
:class: theme-icon

.. |attachments-icon| image:: ../images/paperclip_F03E2.svg
:alt: Add a message attachment using the Upload files icon in the message formatting toolbar.
:class: theme-icon

.. |numbered-icon| image:: ../images/format-list-numbered_F027B.svg
:alt: Format message text as a numbered list using the Numbered list icon in the message formatting toolbar.
:class: theme-icon

.. |bullets-icon| image:: ../images/format-list-bulleted_F0279.svg
:alt: Format message text as a bulleted list using the Bulleted list icon in the message formatting toolbar.
:class: theme-icon

.. |quotes-icon| image:: ../images/format-quote-open_F0757.svg
:alt: Format message text as a quotation using the Quote icon in the message formatting toolbar.
:class: theme-icon

.. |code-icon| image:: ../images/code-tags_F0174.svg
:alt: Format message text as code using the Code icon in the message formatting toolbar.
:class: theme-icon

.. |emoji-icon| image:: ../images/emoticon-outline_F01F2.svg
:alt: Add emojis or GIFs to message text using the Emoji/Gif picker icon in the message formatting toolbar.
:class: theme-icon

.. |hide-formatting-icon| image:: ../images/format-letter-case_F0B34.svg
:alt: Hide formatting options in the message formatting toolbar using the Show/Hide Formatting icon.
:class: theme-icon

.. |preview-icon| image:: ../images/eye-outline_F06D0.svg
:alt: Review your message text formatting using the Show/Hide preview icon in the message formatting toolbar.
:class: theme-icon

.. |settings-icon| image:: ../images/settings-outline_F08BB.svg
:alt: Access and manage your Channels settings using the Gear icon.
:class: theme-icon

.. |message-priority-icon| image:: ../images/alert-circle-outline_F05D6.svg
:alt: Mark a message as important or urgent using the Priority Message icon.
:class: theme-icon

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

Expand All @@ -86,7 +26,7 @@ The message formatting toolbar offers the following formatting options:
| | |strikeout-icon| |
+-------------------------------------------------------------------+-------------------------+
| Add `headings <#headings>`_, `links <#links>`_, | |headings-icon| |
| or attachments | |links-icon| |
| or attachments | |copy-link-icon| |
| | |attachments-icon| |
+-------------------------------------------------------------------+-------------------------+
| Format a numbered list, a bulleted list, quoted text, or | |numbered-icon| |
Expand Down
4 changes: 0 additions & 4 deletions source/collaborate/forward-messages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ Forward messages
.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
:start-after: :nosearch:

.. |more-icon| image:: ../images/dots-horizontal_F01D8.svg
:alt: When you hover over messages, you can access more message options from the More icon.
:class: theme-icon

From Mattermost v7.2, using a web browser or the desktop app, you can forward messages in public channels to other public channels. From Mattermost v7.5, you can also forward messages from bots and webhooks.

.. note::
Expand Down
Loading

0 comments on commit a9b545d

Please sign in to comment.