Skip to content

Commit

Permalink
V9.1-documentation (#6647)
Browse files Browse the repository at this point in the history
* Update conf.py

* [MM-54289] Document pprof metrics in Support Packet (#6674)

* Document pprof metrics in support package

* Fix paragraph

* Update source/manage/common-support-packet.rst

* Update source/manage/common-support-packet.rst

---------

Co-authored-by: Carrie Warner (Mattermost) <[email protected]>

* Convert group messages to private channels (#6690)

* Convert group messages to private channels

* Incorporated reviewer feedback

* Added new & changed v9.1 config settings (#6686)

* Added new & changed v9.1 config settings

* Incorporated developer feedback

* Update source/configure/plugins-configuration-settings.rst

Co-authored-by: Caleb Roseland <[email protected]>

* Table formatting fix

---------

Co-authored-by: Caleb Roseland <[email protected]>

* Invite user groups using ``/invite`` slash command (#6687)

* Invite user groups with invite slash command

* Update source/collaborate/built-in-slash-commands.rst

* Notification keyword keyboard management (#6692)

* v9.1 changelog & docs (#6662)

* Update self-managed-changelog.md

* Update self-managed-changelog.md

* Update self-managed-changelog.md

* Update download-latest-tarball.rst

* Update open-source-components.rst

* Update release-lifecycle.rst

* Update important-upgrade-notes.rst

* Update self-managed-changelog.md

* Update self-managed-changelog.md

* Apply suggestions from code review

Co-authored-by: Carrie Warner (Mattermost) <[email protected]>

* Update self-managed-changelog.md

* Update self-managed-changelog.md

* Update self-managed-changelog.md

* Update self-managed-changelog.md

* Add link

* Update self-managed-changelog.md

* Add contributors

* Update self-managed-changelog.md

* Update self-managed-changelog.md

* Update self-managed-changelog.md

* Update known issues

* Update self-managed-changelog.md

* Update self-managed-changelog.md

* Apply suggestions from code review

Co-authored-by: Carrie Warner (Mattermost) <[email protected]>

* Update self-managed-changelog.md

* Update self-managed-changelog.md

---------

Co-authored-by: Carrie Warner (Mattermost) <[email protected]>

* Contextual shortcut details added (#6696)

* Replaced regular log levels for audit-specific levels (#6702)

* Replaced regular log levels for audit-specific

* Incorporated reviewer feedback

* External provider: out of desktop app during login (#6700)

* External provider: out of desktop app during login

* Incorporated reviewer feedback

* Add documentation on GM notifications (#6684)

* Update channel-types.rst

* Update source/collaborate/channel-types.rst

* Update source/collaborate/channel-types.rst

* Incorporated reviewer feedback

* Incorporated reviewer feedback

---------

Co-authored-by: Carrie Warner (Mattermost) <[email protected]>

* Added contextual links between monitoring & alerts (#6705)

* Docs listening: Added DB config settings link (#6704)

* Added missing redirects reported by community (#6703)

* Panes are resizable (#6701)

* Panes are resizable

* Update source/guides/use-mattermost.rst

* Plan/deployment badge update for pprof metrics (#6694)

* Added availability & badge tables (#6707)

* Added availability & badge tables

* updated status and badge images to be higher quality and transparent backgrounds

---------

Co-authored-by: Matthew Birtch <[email protected]>

* Custom user groups can add users to teams (#6699)

* Can restore archived custom user groups (#6698)

* Channel filter options when browsing channels (#6691)

* Can include archived channels in export (#6695)

* Can include archived channels in export

* Added archived channels flag

---------

Co-authored-by: Carrie Warner (Mattermost) <[email protected]>
Co-authored-by: Ben Schumacher <[email protected]>
Co-authored-by: Caleb Roseland <[email protected]>
Co-authored-by: Daniel Espino García <[email protected]>
Co-authored-by: Matthew Birtch <[email protected]>
  • Loading branch information
6 people authored Oct 16, 2023
1 parent 87138c7 commit 823b65b
Show file tree
Hide file tree
Showing 36 changed files with 397 additions and 70 deletions.
3 changes: 3 additions & 0 deletions source/collaborate/access-your-workspace.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ Mattermost is accessible through a URL link. You'll receive a link from your Mat
3. Enter your user credentials to log into Mattermost.
4. The team that displays first in the team sidebar opens. If you're not a member of a team yet, you're prompted to select a team to join.

.. note::

When you log into Mattermost using external user credentials, such as Google or Office 365, you'll temporarily leave the desktop app during login while authenticating your credentials. Once you're successfully logged in to Mattermost, you'll be returned to the desktop app. See the `Single Sign-On (SSO) <#single-sign-on-sso>`__ section below for details on the external providers that Mattermosts supports.

.. tab:: Mobile

Expand Down
12 changes: 10 additions & 2 deletions source/collaborate/browse-channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,23 @@ Browse channels

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.
2. Select **Browse Channels**.
3. Search for channels by name or scroll through the list.
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.

.. tip::

From Mattermost v9.1, you can filter the list of channels by public, private, or archived channels, and you can hide all channels you're already a member of.

.. 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.
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.
4. Tap a channel to become a member of that channel.

.. tip::

You can filter the list of channels by public, archived, or shared channels.

.. tip::

Expand Down
3 changes: 2 additions & 1 deletion source/collaborate/built-in-slash-commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ The following built-in slash comamnds are available in your Mattermost workspace
Invite people
~~~~~~~~~~~~~

- Invite one person using ``/invite user1`` or ``/invite @user1``
- Invite one person using ``/invite user1`` or ``/invite @user1``.
- Invite a custom user group using ``/invite @usergroup``.
- Invite multiple people using ``/invite @user1 @user2``.
- Invite one person to a specific channel using ``/invite @user1 ~channel1``, or ``/invite @user1 channel1``.
- Invite multiple people to multiple channels using ``/invite @user1 @user2 ~channel1 ~channel2``.
Expand Down
10 changes: 7 additions & 3 deletions source/collaborate/channel-types.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,17 @@ Channel members can choose to leave private channels at any time.
Direct messages
---------------

Direct messages are channels for conversations between two people. You can also start a direct message with people on other teams when enabled by the System Admin. Only members of the conversation can see direct messages and channel heading information, including last active status of the other user, when enabled.
Direct messages conversations between 2 people. You can start a direct message with people on other teams `when enabled by the system admin </configure/site-configuration-settings.html#users-restrictdirectmessage>`__. Only members of the conversation can see direct messages and channel heading information, including the last active status of the other user.

Direct messages increment the numbered badge and trigger a notification unless the direct message is muted, or your notifications are disabled. See the `notification documentation </preferences/manage-your-notifications.html>`__ for details on customizing notifications based on your preferences.

Group messages
--------------

Group messages are channels for conversations among three or more people and up to seven people. You can also start a group message with people on other teams when enabled by the System Admin. Only members of the conversation can see group messages.
Group messages are conversations between 3 to 7 people. You can also start a group message with people on other teams when `enabled by the system admin </configure/site-configuration-settings.html#users-restrictdirectmessage>`__. Only members of the conversation can see group messages. Group messages always display a new message badge.

From Mattermost v9.1, group messages increment the numbered badge and trigger a notification unless the direct message is muted, or your notifications are disabled. You can control how you're notified about group message conversations by going to **Settings > Notifications**. See the `notification documentation </preferences/manage-your-notifications.html>`__ to learn more.

.. tip::

Create a private channel to communicate with more than seven people.
Want to have a group conversation with more than 7 people? You can `create a private channel </collaborate/create-channels.html>`__. Alternatively, from Mattermost v9.1, you can `convert the group message to a private channel </collaborate/convert-onvert-group-messages.html>`__.
6 changes: 4 additions & 2 deletions source/collaborate/collaborate-within-channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ Learn more about collaborating within Mattermost channels:
Communicate a channel's focus and scope </collaborate/channel-header-purpose>
Create channels </collaborate/create-channels>
Rename channels </collaborate/rename-channels>
Convert public channels to private </collaborate/convert-public-channels>
Convert public channels to private channels </collaborate/convert-public-channels>
Convert group messages to private channels </collaborate/convert-group-messages>
Join and leave channels </collaborate/join-leave-channels>
Make calls in Mattermost </collaborate/make-calls>
Manage channel members </collaborate/manage-channel-members>
Expand All @@ -68,7 +69,8 @@ Learn more about collaborating within Mattermost channels:
* :doc:`Navigate between channels </collaborate/navigate-between-channels>` - Learn how to navigate between channels.
* :doc:`Create channels </collaborate/create-channels>` - Create channels to organize discussion by topic, project, or focus.
* :doc:`Rename a channel </collaborate/rename-channels>` - Rename channels to make them more discoverable.
* :doc:`Convert public channels to private </collaborate/convert-public-channels>` - Learn how to convert channel access and visibility.
* :doc:`Convert public channels to private channels </collaborate/convert-public-channels>` - Learn how to convert channel access and visibility.
* :doc:`Convert group messages to private channels </collaborate/convert-group-messages>` - Learn how to convert group messages to private channels.
* :doc:`Manage channel members </collaborate/manage-channel-members>` - Add and remove users from channels.
* :doc:`Mark channels as favorites </collaborate/favorite-channels>` - Mark commonly visited channels as favorites.
* :doc:`Mark channels as unread </collaborate/mark-channels-unread>` - Mark channels unread to return to messages later.
Expand Down
20 changes: 20 additions & 0 deletions source/collaborate/convert-group-messages.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Convert group messages to private channels
==========================================

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

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::

- Any member of an existing group message, except `guests </onboard/guest-accounts.html>`__, can convert that group message to a private channel.
- All group message particpants must share at least one team membership.
- You can convert a group message to a private channel using a web browser or the desktop app.

To convert a group message to a private channel:

1. Select the group message name at the top of the center pane to access the drop-down menu, then select **Convert to Private Channel**.
2. Specify the team where the new private channel will be created. You're prompted to specify a team when all group message members share more than one team membership.
3. Enter a channel name.
4. Select **Convert to private channel**.
2 changes: 1 addition & 1 deletion source/collaborate/convert-public-channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ Convert private channels to public channels

Due to potential security concerns with sharing private channel history, only system admins can convert private channels to public channels via **System Console > Channels > Edit (Channel Configuration)**.

Alternatively, System Admins can perform this action using the `mmctl channel modify command </manage/mmctl-command-line-tool.html#mmctl-channel-modify>`__.
Alternatively, system admins can perform this action using the `mmctl channel modify command </manage/mmctl-command-line-tool.html#mmctl-channel-modify>`__.
10 changes: 8 additions & 2 deletions source/collaborate/invite-people.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,14 @@ All users can add existing Mattermost users to a Mattermost team or channel, unl
.. tip::

- Add users to a channel by selecting the channel name and selecting **Add Members**.
- Add groups of users to a channel by `creating a custom group </collaborate/organize-using-custom-user-groups.html>`__ and `@mentioning </collaborate/mention-people.html>`__ the custom group in a channel. Mattermost will prompt to you to add any users who aren't already members of that channel.
- A guest is a special role that is restricted to only the channels they have been invited to. When guest access is enabled, you can invite guests or users external to the organization, such as vendors or customers.
- Add groups of users to a channel or team by `creating a custom group </collaborate/organize-using-custom-user-groups.html>`__ and `@mentioning </collaborate/mention-people.html>`__ the custom group in a channel.

- Mattermost prompts to you to add any users who aren't already members of that channel to the channel.
- From Mattermost v9.1, you're given the option to add any users who aren't already members of that team to the team, if you have the permissions to do so.

- A `guest user </onboard/guest-accounts.html>`__ in Mattermost is a special role that is restricted to only the channels they have been invited to. When `guest access is enabled </configure/authentication-configuration-settings.html#guest-enable>`__ by the system admin, you can invite guests or users external to the organization, such as vendors or customers.

- Once guests are invited to the team, you can add them to the channel.

Send a direct invite
~~~~~~~~~~~~~~~~~~~~
Expand Down
3 changes: 2 additions & 1 deletion source/collaborate/keyboard-shortcuts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ The following keyboard shortcuts for channels are supported in all `supported br
+-------------------------------------+------------------------------+----------------------------------------------------------------------------------+
| :kbd:`Alt` + select channel | :kbd:`` + select channel | Mark the last post in the channel as unread. |
+-------------------------------------+------------------------------+----------------------------------------------------------------------------------+
| :kbd:`Ctrl` :kbd:`K` | :kbd:`` :kbd:`K` | Open the **Find Channels** dialog. |
| :kbd:`Ctrl` :kbd:`K` | :kbd:`` :kbd:`K` | - If text isn't selected: Open the **Find Channels** dialog. |
| | | - If text is selected: Create a hyperlink in the format ``[linktext](URL)``. |
+-------------------------------------+------------------------------+----------------------------------------------------------------------------------+
| :kbd:`Ctrl` :kbd:`Shift` :kbd:`K` | :kbd:`` :kbd:`` :kbd:`K` | Open the **Direct Messages** dialog. |
+-------------------------------------+------------------------------+----------------------------------------------------------------------------------+
Expand Down
14 changes: 13 additions & 1 deletion source/collaborate/mention-people.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ When you want to get the attention of specific Mattermost users, you can use @me
- `@all <#channel-and-all>`__
- `@here <#here>`__
- `@groupname <#groupname>`__
- `@customusergroupname <#customusergroupname>`__

.. note::

Expand Down Expand Up @@ -85,6 +86,17 @@ As with ``@username`` mentions, use *@* to bring up a list of groups that can be
@dev-managers great work hitting all of our code coverage goals this quarter!
@customusergroupname
--------------------

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

You can add groups of users to a channel or team by `creating a custom group </collaborate/organize-using-custom-user-groups.html>`__ and @mentioning that custom group in a channel.

- Mattermost prompts to you to add any users who aren't already members of that channel to the channel.
- From Mattermost v9.1, you're given the option to add any users who aren't already members of that team to the team, if you have the permissions to do so.

Words that trigger mentions
---------------------------

Expand All @@ -107,7 +119,7 @@ Select **Jump** next to a search result in the right-hand sidebar to jump the ce
Confirmation dialog warnings
----------------------------

When your system admin has configured Mattermost to require confirmations for @messages, you must confirm any mention that will trigger notifications for more than five users before sending the notification.
When your system admin has configured Mattermost to require confirmations for @mentions, you must confirm any mention that will trigger notifications for more than five users before sending the notification.

This confirmation dialog only appears when your system admin has configured this setting in the System Console. See our `configuration settings </configure/configuration-settings.html#show-channel-all-or-here-confirmation-dialog>`__ product documentation for details. This configuration setting is supported on the Mattermost Mobile App (from v1.34) if the `AD/LDAP groups </onboard/ad-ldap-groups-synchronization.html>`__ feature is enabled.

Expand Down
34 changes: 27 additions & 7 deletions source/collaborate/organize-using-custom-user-groups.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,19 @@ Manage custom groups (beta)
.. include:: ../_static/badges/ent-pro-cloud-selfhosted.rst
:start-after: :nosearch:

.. |more-icon-vertical| image:: ../images/dots-vertical_F01D9.svg
:alt: Use the More icon in the top left corner to access Mattermost desktop apps customization settings.

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

*Not available in legacy Enterprise Edition E10/E20*

Custom groups (beta) reduce noise and improve focus by notifying the right people in a channel at the right time, while maintaining transparency for all members in that channel. Custom user groups let you notify up to 256 users at a time rather than notifying users individually.

For example, perhaps you want to @mention a cross-functional team about a bug fixes needed for an upcoming feature release, without notifying everyone else in the channel. Using a custom group notifies the cross-functional team immediately, while keeping important stakeholders in the loop on the status of the feature release.

Or perhaps you want to add a group of users to a channel. When you @mention a custom group in a channel, Mattermost prompts you to add anyone from that custom group who isn't already a channel member.
Or perhaps you want to add a group of users to a team and a channel. When you @mention a custom group in a channel, Mattermost prompts you to add anyone from that custom group who isn't already a channel and team member. See the `invite people to your workspace </collaborate/invite-people.html>`__ documentation for details.

Once a custom user group has been created, you can mention that group the same way you @mention another Mattermost member. See the `mention people in messages </collaborate/mention-people.html>`__ documentation for details.

Expand All @@ -23,7 +29,7 @@ Once a custom user group has been created, you can mention that group the same w
Create a custom group
---------------------

1. Using Mattermost in a web browser or the desktop app, select **+** from the top of the channel sidebar, then select **Create New User Group**.
1. Using Mattermost in a web browser or the desktop app, select |plus| at the top of the channel sidebar, then select **Create New User Group**.

2. Specify a name and mention. The mention is the handle you use to @mention a notification to the group. Group names must be unique across the Mattermost workspace. If a name is in use as a channel name, display name, or another custom group's name, it won't be available.

Expand All @@ -47,17 +53,21 @@ To manage a custom user group in a web browser or the desktop app, select **User
Review available groups
~~~~~~~~~~~~~~~~~~~~~~~

Review a list of all available custom user groups, search for specific groups by name, or filter the list of groups to display only groups you're a member of.
Review a list of all available custom user groups, search for specific groups by name.

.. tip::

You can filter the list of groups to display only groups you're a member of, or only archived groups.

Change name or mention
~~~~~~~~~~~~~~~~~~~~~~

1. From the **More Actions** icon to the right of any custom group, select **View Group**.
1. From the **More Actions** |more-icon-vertical| icon to the right of any custom group, select **View Group**.

.. image:: ../images/manage-user-groups.png
:alt: Access tools to manage your custom user groups.

2. From the **More Actions** icon, select **Edit Details**.
2. From the **More Actions** |more-icon-vertical| icon, select **Edit Details**.

.. image:: ../images/edit-custom-group.png
:alt: Edit details of a custom user group.
Expand All @@ -75,12 +85,22 @@ Remove people

Hover over a member, then select the **Trash** icon to remove them from the group.

Join a group
~~~~~~~~~~~~

While viewing the members of a group, from the **More Actions** |more-icon-vertical| icon, select **Join Group**.

Leave a group
~~~~~~~~~~~~~

From the **More Actions** icon, select **Leave Group**.
From the **More Actions** |more-icon-vertical| icon, select **Leave Group**.

Archive group
~~~~~~~~~~~~~

From the **More Actions** icon, select **Archive Group**. When you archive a custom user group, you won’t be able to mention the group’s handle or view its members. However, the group isn't deleted from the list, and all members remain in the group unless manually removed.
From the **More Actions** |more-icon-vertical| icon, select **Archive Group**. When you archive a custom user group, you won’t be able to mention the group’s handle or view its members. However, the group isn't deleted from the list, and all members remain in the group unless they're manually removed.

Unarchive group
~~~~~~~~~~~~~~~

From Mattermost v9.1, you can restore an archived group. From the **More Actions** |more-icon-vertical| icon, filter the list of groups to show only archived groups. Select an archived group view details about the group, if preferreed, and then select **Restore Group**.
Loading

0 comments on commit 823b65b

Please sign in to comment.