Skip to content

AI-Aided: Add documentation for automatic channel category sorting feature (v10.10) #8089

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: v10.10-documentation
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions source/collaborate/create-channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Anyone can create public channels, private channels, direct messages, and group
2. Enter a channel name.
3. Choose whether this is a public or private channel. See the :doc:`channel types </collaborate/channel-types>` documentation to learn more about public and private channels.
4. (Optional) Describe the channel's focus or purpose. This text is visible to all channel members in the channel header.
5. (Optional) Assign the channel to a category. If your system admin has enabled the :ref:`Enable channel category sorting <configure/experimental-configuration-settings:enable channel category sorting>` experimental feature, you can select an existing category or create a new one to organize your channel. If this option isn't available, you can organize channels into categories after creation using :doc:`channel sidebar customization </preferences/customize-your-channel-sidebar>`.

**To start a direct or group message**

Expand All @@ -42,6 +43,8 @@ Anyone can create public channels, private channels, direct messages, and group

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.

If your system admin has enabled the :ref:`Enable channel category sorting <configure/experimental-configuration-settings:enable channel category sorting>` experimental feature, you can also assign the channel to a category during creation by selecting an existing category or creating a new one.

.. image:: ../images/create-channel-or-open-direct-message-on-mobile.jpg
:alt: You can create a new channel by tapping the plus in the top right corner.
:scale: 30
Expand Down
4 changes: 4 additions & 0 deletions source/collaborate/rename-channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Anyone can rename the channels they belong to, unless the system admin has :doc:
- **Channel name:** The channel name that displays in the Mattermost user interface for all users. Enter a different channel name if needed or preferred.
- **Channel URL:** The web URL used to access the channel in a web browser. Select **Edit** to change the URL, and select **Done** to save your changes.

If your system admin has enabled the :ref:`Enable channel category sorting <configure/experimental-configuration-settings:enable channel category sorting>` experimental feature, you may also see an option to assign the channel to a different category or create a new category during the renaming process.

For example, a channel could be named ``UX Design`` and have a URL of ``https://community.mattermost.com/core/channels/ux-design``.

.. tab:: Mobile
Expand Down Expand Up @@ -47,6 +49,8 @@ Anyone can rename the channels they belong to, unless the system admin has :doc:
- **Purpose:** (Optional) Used to describe the channel's function or goal.
- **Header:** (Optional) Used to include information relevant to the channel, such as key contacts or document links.

If your system admin has enabled the :ref:`Enable channel category sorting <configure/experimental-configuration-settings:enable channel category sorting>` experimental feature, you may also see an option to assign the channel to a different category or create a new category.

Tap on **Save** to save the new channel name.

.. image:: ../images/mobile-rename-channel-name-and-save.jpg
Expand Down
26 changes: 26 additions & 0 deletions source/configure/experimental-configuration-settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1607,6 +1607,32 @@ This setting applies to the new sidebar only. You must disable the :ref:`Enable
| This feature's ``config.json`` setting is ``"ExperimentalGroupUnreadChannels": "default_off"`` with options ``"default_off"`` and ``"default_on"``. |
+-----------------------------------------------------------------------------------------------------------------------------------------------------+

.. config:setting:: enable-channel-category-sorting
:displayname: Enable channel category sorting (Experimental)
:systemconsole: Experimental > Features
:configjson: ExperimentalEnableChannelCategorySorting
:environment: N/A

- **true**: Enables users to assign channels to categories during channel creation and renaming workflows.
- **false**: **(Default)** Disables automatic channel category assignment during channel creation and renaming.

Enable channel category sorting
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

.. note::
This is an experimental feature introduced in Mattermost v10.10. When enabled, users can select or create custom categories to organize their channels during the channel creation and renaming processes.

**True**: Enables users to assign channels to categories during channel creation and renaming workflows. When creating or renaming a channel, users will see an option to select an existing category or create a new category for the channel.

**False**: Disables automatic channel category assignment during channel creation and renaming. Users must manually organize channels into categories after creation using the channel sidebar customization options.

+------------------------------------------------------------------------------------------------------------------------------------------+
| This feature's ``config.json`` setting is ``"ExperimentalEnableChannelCategorySorting": false`` with options ``true`` and ``false``. |
+------------------------------------------------------------------------------------------------------------------------------------------+

.. config:setting:: strict-csrf-token-enforcement
:displayname: Strict CSRF token enforcement (Experimental)
:systemconsole: N/A
Expand Down
3 changes: 3 additions & 0 deletions source/preferences/customize-your-channel-sidebar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ Create custom categories to group channels together for quicker and easier navig

To create categories, select the **+** symbol at the top of the sidebar. Or, select the **More options** |more-icon| icon in the sidebar on any category header, then select **Create New Category**.

.. note::
If your system admin has enabled the :ref:`Enable channel category sorting <configure/experimental-configuration-settings:enable channel category sorting>` experimental feature (available from Mattermost v10.10), you can also assign channels to categories directly during :doc:`channel creation </collaborate/create-channels>` and :doc:`channel renaming </collaborate/rename-channels>` workflows.

Next, type a category name, select **Create**, then drag any channels or direct messages into this new category. You can also multi-select channels and direct messages to drag them together as a group by pressing :kbd:`Ctrl` or :kbd:`Shift` and selecting on Windows or Linux, or :kbd:`⌘` or :kbd:`⇧` and selecting on Mac. See the section `drag and drop selections <#drag-and-drop-selections>`__ below for details.

Your custom categories can't be shared with other Mattermost users.
Expand Down