Skip to content

Commit

Permalink
Added bookmarks docs & permissions (#7452)
Browse files Browse the repository at this point in the history
  • Loading branch information
cwarnermm authored Oct 15, 2024
1 parent d80c173 commit 1039695
Show file tree
Hide file tree
Showing 11 changed files with 171 additions and 4 deletions.
2 changes: 2 additions & 0 deletions source/collaborate/collaborate-within-channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ Learn more about collaborating within Mattermost channels:
Browse channels </collaborate/browse-channels>
Navigate between channels </collaborate/navigate-between-channels>
Mark channels as favorites </collaborate/favorite-channels>
Manage channel bookmarks </collaborate/manage-channel-bookmarks>
Mark channels as unread </collaborate/mark-channels-unread>
Archive and unarchive channels </collaborate/archive-unarchive-channels>

Expand All @@ -67,5 +68,6 @@ Learn more about collaborating within Mattermost channels:
* :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:`Manage channel bookmarks </collaborate/manage-channel-bookmarks>` - Manage quick access links or files pinned to the top of channels.
* :doc:`Mark channels as unread </collaborate/mark-channels-unread>` - Mark channels unread to return to messages later.
* :doc:`Archive and unarchive channels </collaborate/archive-unarchive-channels>` - Keep the number of available channels manageable.
4 changes: 2 additions & 2 deletions source/collaborate/learn-about-roles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,12 @@ The person who creates a channel is assigned the channel admin role for that cha
- Ability to remove members from the channel.
- Ability to configure channel actions that automate tasks based on trigger conditions, such as :ref:`joining a channel <collaborate/join-leave-channels:join a channel>` or :doc:`sending a message </collaborate/send-messages>` in a channel.

Depending on your system configuration, channel admins can be granted special permissions by the system admin to rename and delete channels.
Depending on your system configuration, channel admins can be granted special permissions by the system admin to rename and delete channels.

Member
------

This is the default role given to users when they join a team. Members have basic permissions on a Mattermost team.
This is the default role given to users when they join a team. Members have basic permissions on a Mattermost team. See the :doc:`advanced permissions backend infrastructure </onboard/advanced-permissions-backend-infrastructure>` documentation for details.

Guest
-----
Expand Down
116 changes: 116 additions & 0 deletions source/collaborate/manage-channel-bookmarks.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
Manage channel bookmarks
=========================

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

You can bookmark up to 50 links or files to the top of channels for quick and easy access, unless your system admin has disabled your ability to do so. Bookmarked links and files display in the bookmarks bar located directly below the channel header.

.. tip::

Any file added as a channel bookmark is also searchable in Mattermost.

Open a bookmark
---------------

Opening a channel bookmark works the same way as selecting a file link or attachment in a message. Select or tap a bookmark to view the file or link.

Add a bookmark
--------------

.. tab:: Web/Desktop

1. In the bookmarks bar, select **Add a bookmark**.

.. image:: ../images/desktop-bookmark-add.png
:alt: Using a web browser or the desktop app, select the Plus icon to add a channel bookmark.
:scale: 50

- Select **Add a link** to specify the link URL, specify bookmark text, and an optional bookmark icon.
- Select **Add a file** to select a file, specify bookmark text, and an optional bookmark icon.

.. image:: ../images/desktop-bookmark-add-choice.png
:alt: Using a web browser or the desktop app, choose whether to add a link or a file.
:scale: 50

.. tab:: Mobile

The bookmarks bar is hidden by default when a channel has no bookmarks.

1. Select the **More** |more-icon| icon and select **View info**, and **Add a bookmark** to add the first bookmark. For subsequent bookmarks, select the **Plus** |plus| icon in the bookmarks bar.

.. image:: ../images/mobile-bookmark-add.png
:alt: Using the mobile app, go to the channel view info screen to add a bookmark for the first time.
:scale: 50

- Select **Add a link** to specify the link URL, specify bookmark text, and an optional bookmark icon.
- Select **Add a file** to select a file, specify bookmark text, and an optional bookmark icon.

.. image:: ../images/mobile-bookmark-add-choice.png
:alt: Using the mobile app, choose whether to add a link or a file.
:scale: 50

.. image:: ../images/mobile-bookmark-add-details.png
:alt: Using the mobile app, specify the link or file, bookmark text, and an optional bookmark icon.
:scale: 50

2. Select **Add bookmark**.

Manage bookmarks
----------------

You can `edit <#edit-bookmarks>`__ and `delete <#delete-bookmarks>`__ bookmarks, as well as `copy bookmark links <#copy-bookmark-links>`__. Additionally, web and desktop users can `reorder bookmarks <#reorder-bookmarks>`__, and mobile users can `share bookmarks <#share-bookmarks>`__. Changes to bookmarks are visible to all channel members.

Reorder bookmarks
^^^^^^^^^^^^^^^^^

Using Mattermost in a web browser or the desktop app, drag bookmarks to reorder them in the bookmarks bar. Reordering channel bookmarks changes the display order for all channel members.

.. note::

You can't reorder channel bookmarks using the mobile app.

Edit bookmarks
^^^^^^^^^^^^^^^

You can make changes to the bookmark link or file, the bookmark title, or the optional bookmark icon. Editing a bookmark changes the bookmark for all channel members.

.. tab:: Web/Desktop

Select the **More** |more-icon| icon next to a bookmark and select **Edit**.

.. tab:: Mobile

Long-press on a bookmark and select **Edit**.

Share bookmarks
^^^^^^^^^^^^^^^^

Using the mobile app, long-press on a bookmark and select **Share**.

Copy bookmark links
^^^^^^^^^^^^^^^^^^^^

You can copy bookmark links when your system admin has :ref:`enabled your ability to do so <configure/site-configuration-settings:enable public file links>`.

.. tab:: Web/Desktop

Select the **More** |more-icon| icon next to a bookmark and select **Copy link**.

.. tab:: Mobile

Long-press on a bookmark and select **Copy link**.

Delete bookmarks
^^^^^^^^^^^^^^^^^

Deleting a channel bookmark deletes it for all channel members.

.. tab:: Web/Mobile

Select the **More** |more-icon| icon next to a bookmark and select **Delete**.

.. tab:: Mobile

Long-press on a bookmark and select **Delete**.

Binary file added source/images/desktop-bookmark-add-choice.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 added source/images/desktop-bookmark-add-details.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 added source/images/desktop-bookmark-add.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 added source/images/mobile-bookmark-add-choice.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 added source/images/mobile-bookmark-add-details.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 added source/images/mobile-bookmark-add.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 3 additions & 2 deletions source/manage/team-channel-members.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,9 @@ Advanced access control settings enable system admins to restrict actions within

- **Make channel read-only:** :ref:`Read-only channels <onboard/advanced-permissions:read only channels>` enable system admins to turn off posting in specified channels.
- **Restrict reactions:** Turn off the ability for members and guests to post reactions.
- **Restrict channel mentions:** Turn off the ability for users to post channel wide mentions (@all/channel/here) in specified channels.
- **Channel member management:** Only Admins have the ability to add and remove channel members in the specified channels.
- **Restrict channel mentions:** Turn off the ability for users to post channel wide mentions (@all/@channel/@here) in specified channels.
- **Channel member management:** Only admins have the ability to add and remove channel members in the specified channels.
- **Bookmarks management:** Only channel and system admins can :doc:`manage channel bookmarks </collaborate/manage-channel-bookmarks>`.

These settings are modified in **System Console > User Management > Channels**.

Expand Down
48 changes: 48 additions & 0 deletions source/onboard/advanced-permissions-backend-infrastructure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,22 @@ Permissions in Mattermost are a property of the server code base and are not cre
+----------------------------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| manage_ldap_sync_job | system | Manage the status of an LDAP synchronization job. |
+----------------------------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| add_bookmark_public_channel | channel | Add bookmarks to a public channel. |
+----------------------------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| add_bookmark_private_channel | channel | Add bookmarks to a private channel. |
+----------------------------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| edit_bookmark_public_channel | channel | Make changes to bookmarks in a public channel. |
+----------------------------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| edit_bookmark_private_channel | channel | Make changes to bookmarks in a private channel. |
+----------------------------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| delete_bookmark_public_channel | channel | Delete bookmarks in a public channel. |
+----------------------------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| delete_bookmark_private_channel | channel | Delete bookmarks in a private channel. |
+----------------------------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| order_bookmark_public_channel | channel | Reorder bookmarks in a public channel. |
+----------------------------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| order_bookmark_private_channel | channel | Reorder bookmarks in a private channel. |
+----------------------------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

``Roles`` field
~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -260,6 +276,14 @@ The following built-in roles and associated permissions are available:
- remove_reaction
- manage_public_channel_members
- manage_channel_roles
- add_bookmark_public_channel
- edit_bookmark_public_channel
- delete_bookmark_public_channel
- order_bookmark_public_channel
- add_bookmark_private_channel
- edit_bookmark_private_channel
- delete_bookmark_private_channel
- order_bookmark_private_channel

*channel_guest*

Expand Down Expand Up @@ -293,6 +317,14 @@ The following built-in roles and associated permissions are available:
- manage_private_channel_properties
- create_post
- edit_post
- add_bookmark_public_channel
- edit_bookmark_public_channel
- delete_bookmark_public_channel
- order_bookmark_public_channel
- add_bookmark_private_channel
- edit_bookmark_private_channel
- delete_bookmark_private_channel
- order_bookmark_private_channel

*system_admin*

Expand Down Expand Up @@ -416,6 +448,14 @@ The following built-in roles and associated permissions are available:
- manage_elasticsearch_post_indexing_job
- manage_elasticsearch_post_aggregation_job
- manage_ldap_sync_job
- add_bookmark_public_channel
- edit_bookmark_public_channel
- delete_bookmark_public_channel
- order_bookmark_public_channel
- add_bookmark_private_channel
- edit_bookmark_private_channel
- delete_bookmark_private_channel
- order_bookmark_private_channel

*system_custom_group_admin*

Expand Down Expand Up @@ -591,6 +631,14 @@ The following built-in roles and associated permissions are available:
- convert_public_channel_to_private
- add_reaction
- import_team
- add_bookmark_public_channel
- edit_bookmark_public_channel
- delete_bookmark_public_channel
- order_bookmark_public_channel
- add_bookmark_private_channel
- edit_bookmark_private_channel
- delete_bookmark_private_channel
- order_bookmark_private_channel

*team_guest*

Expand Down

0 comments on commit 1039695

Please sign in to comment.