Skip to content

Commit

Permalink
V9.7 Docs (#6980)
Browse files Browse the repository at this point in the history
* Update conf.py

* Update download-latest-tarball.rst

* Update download-latest-tarball.rst

* Update download-latest-tarball.rst

* Update download-latest-tarball.rst

* Corrected config setting name for onboarding flow (#7006)

* Added guidance for max image decoder concurrency (#7010)

* Added guidance for max image decoder concurrency

* Incorporated reviewer feedback

* Added 2 new  profiling reports: allocs & mutex (#7008)

* Corrected default value for OutgoingIntegrationRequestsDefaultTimeout (#7013)

* Reordered page & provided next steps to share packet (#7009)

* Deprecated MaxIdleConns, MaxIdleConnsPerHost, and IdleConnTimeoutMilliseconds & removed multiple deprecated settings from telemetry docs (#7014)

* Update download-latest-tarball.rst

* Clarify consequences of EmailBatchingBufferSize & EmailBatchingInterval config settings (#7015)

* Added links to technical GH repo docs re: rtcd (#7034)

* Corrected inline LaTeX rendering in message text as disabled by default (#7036)

* Added legacy redirects impacting top forum engagement topics (#7037)

* Forum listening: Added archival/deletion context for default channels (#7038)

* Added archival/deletion context for default channels

* Corrected note syntax

* Forum listening: Clarified status activity & added link to away configuration setting (#7039)

* Clarified status activity & added link to away configuration setting

* Rearranged order of 2 table bullets

* Added theme-icon class to status images to support Dark Mode

* Added config setting needed to create accounts for preview instances (#7041)

* Fixed malformed syntax for per-channel notification preferences (#7042)

* Clarified who can make new threads (#7043)

* Clarified ServiceSettings for EnableTutorial & EnableOnboardingFlow (#7045)

* Clarified conversion from private to public workflow (#7046)

* Forum listening: Added uninstall FAQ when desktop app installed via snap on linux (#7040)

* Added uninstall FAQ when desktop app installed via snap on linux

* Shortened table width to fit on page without requiring horizontal scroll

* Add 0.3 legal hold demo to the docs (#7044)

* Add 0.3 demo to the docs

* Added sneak peek video

* Fixed broken ref link syntax

* v9.7 changelog (#6985)

* Update release-lifecycle.rst

* Update open-source-components.rst

* Update download-latest-tarball.rst

* Update download-latest-tarball.rst

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Add contributors

* Update mattermost-changelog.md

* Update source/deploy/mattermost-changelog.md

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Update source/deploy/mattermost-changelog.md

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Update source/deploy/mattermost-changelog.md

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Update mattermost-changelog.md

* Update mattermost-changelog.md

---------

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

---------

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>
  • Loading branch information
amyblais and cwarnermm authored Apr 16, 2024
1 parent c1edb5d commit 0012645
Show file tree
Hide file tree
Showing 27 changed files with 317 additions and 176 deletions.
25 changes: 17 additions & 8 deletions source/collaborate/archive-unarchive-channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,16 @@ Archive and unarchive channels
Archive a channel
-----------------

Anyone using Mattermost can archive the public channels or private channels they belong to, unless the system admin has restricted the permissions to do so. System admins can archive channels in the System Console without needing to be a channel member. When a channel is archived, it's removed from the user interface, but a copy exists on the server in case it's needed for audit reasons at a later stage. Because a copy of the channel exists on the server, you can't reuse the URL of an archived channel when creating a new channel.
You can delete a channel in Mattermost when it's no longer useful by archiving it. Anyone using Mattermost can archive the public channels or private channels they're a member of, unless the system admin has restricted the permissions to do so.

When a channel is archived, it's deleted from the user interface, but a copy exists on the server in case it's needed for audit reasons in the future, or in case you decide to restore the channel by `unarchiving it <#unarchive-a-channel>`__.

.. note::

- All users are added to the **Off-Topic** and **Town Square** channels automatically. Users can't archive, `unarchive <#unarchive-a-channel>`__, or :ref:`leave <collaborate/join-leave-channels:leave a channel>` these channels.
- System admins can archive channels in the System Console without needing to be a channel member.
- Because a copy of the channel exists on the server, you can't reuse the URL of an archived channel when :doc:`creating a new channel </collaborate/create-channels>`.
- Instead of archiving the channel, you can also leave it open and post a message in the channel saying it's considered archived, such as: ``# This channel is archived.``

.. tab:: Web/Desktop

Expand All @@ -21,20 +30,20 @@ Anyone using Mattermost can archive the public channels or private channels they

To archive a channel:

1. Tap the channel you want to archive.
1. Tap the channel you want to delete.
2. Tap the **More** |more-icon| icon located in the top right corner of the app.
3. Tap **View info**.
4. Tap **Archive Channel**.
5. Tap **Yes** to confirm.

.. tip::

Instead of archiving, you can also leave the channel open and post a message in the channel saying it's considered archived, such as: ``# This channel is archived.``

Unarchive a channel
-------------------

System admins and Team admins can unarchive public channels or private channels they belonged to before they were archived. When a channel is unarchived, channel membership and all its content is restored, unless messages and files have been deleted based on the :ref:`data retention policy <configure/compliance-configuration-settings:data retention policies>`.
System admins and Team admins can restore archived channels. When a channel is unarchived, channel membership and all its content is restored, unless messages and files have been deleted based on the :ref:`data retention policy <configure/compliance-configuration-settings:data retention policies>`.

.. note::

All users are added to the **Off-Topic** and **Town Square** channels automatically. Users can't `archive <#archive-a-channel>`__, unarchive, or :ref:`leave <collaborate/join-leave-channels:leave a channel>` these channels.

.. tab:: Web/Desktop

Expand All @@ -55,4 +64,4 @@ System admins and Team admins can unarchive public channels or private channels

.. tip::

Alternatively, system admins can unarchive channels :ref:`via the mmctl <manage/mmctl-command-line-tool:mmctl channel unarchive>`. Team admins can unarchive channels `via the API <https://api.mattermost.com/#operation/RestoreChannel>`__.
Alternatively, system admins can unarchive channels :ref:`via the mmctl <manage/mmctl-command-line-tool:mmctl channel unarchive>`, and Team admins can unarchive channels `via the API <https://api.mattermost.com/#operation/RestoreChannel>`__.
4 changes: 3 additions & 1 deletion source/collaborate/channel-types.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ Sending messages, replying to messages, and participating in conversation thread
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**. See the :doc:`Join and leave channels </collaborate/join-leave-channels>` documentation for details on discovering and joining other 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**.

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

Private channels
----------------
Expand Down
7 changes: 5 additions & 2 deletions source/collaborate/collaborate-within-channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,13 @@ Channels are where you connect, collaborate, and communicate with your team abou
You're added to default channels automatically
----------------------------------------------

Everyone who joins a Mattermost workspace is automatically added to two default channels: **Town Square** and **Off-Topic**. See our :doc:`Channel Types </collaborate/channel-types>` documentation for details.
Everyone who joins a Mattermost workspace is automatically added to two default public channels: **Town Square** and **Off-Topic**. See our :doc:`Channel Types </collaborate/channel-types>` documentation for details.

- **Town Square** is great for your team-wide communications, such as announcements.
- **Off-Topic** is great for fun, social, non-work-related conversations.
- **Off-Topic** is great for fun, social, non-work-related conversations.

.. note::
All users are added to the **Off-Topic** and **Town Square** channels automatically. Users can't :ref:`archive <collaborate/archive-unarchive-channels:archive a channel>`, :ref:`unarchive <collaborate/archive-unarchive-channels:unarchive a channel>`, or :ref:`leave <collaborate/join-leave-channels:leave a channel>` these channels.

Channel sidebar
----------------
Expand Down
11 changes: 9 additions & 2 deletions source/collaborate/convert-public-channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,13 @@ You must be a system admin or team admin to convert public channels to private c
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)**.
Due to potential security concerns with sharing private channel history, only system admins can convert private channels to public channels.

Alternatively, system admins can perform this action using the :ref:`mmctl channel modify command <manage/mmctl-command-line-tool:mmctl channel modify>`.
1. Go to **System Console > Channels**.
2. Select **Edit** for an existing private channel. You can also filter the list of channels to private channels only.
3. Under **Channel Management > Public channel or private channel**, select **Private**. If :ref:`Sync Group channel management <manage/team-channel-members:channel management>` is enabled, private channels can't be converted to public channels.
4. Select **Save**.

.. tip::

Alternatively, system admins can convert private channels to public channels using the :ref:`mmctl channel modify command <manage/mmctl-command-line-tool:mmctl channel modify>`.
35 changes: 20 additions & 15 deletions source/collaborate/install-desktop-app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,21 +39,21 @@ You can `download the desktop app directly from our Downloads page <https://matt
- MSI for `64-bit version of Windows <https://releases.mattermost.com/desktop/5.7.0/mattermost-desktop-5.7.0-x64.msi>`__
- MSI for `32-bit version of Windows <https://releases.mattermost.com/desktop/5.7.0/mattermost-desktop-5.7.0-x86.msi>`__

The following group policies are available:

+--------------------------+------------------------------------------------------------+----------------------+----------------------------+------------------+
| Group policy | Description | Mattermost release | Setting | State options |
+==========================+============================================================+======================+============================+==================+
| Enable Server Management | If disabled, management of servers in the | v4.3 or later | ``EnableServerManagement`` | - Not Configured |
| | app settings are disabled. | | | - Enabled |
| | | | | - Disabled |
+--------------------------+------------------------------------------------------------+----------------------+----------------------------+ |
| Default Server List | Define one or more default, permanent servers. | v4.3 or later | ``DefaultServerList`` | |
+--------------------------+------------------------------------------------------------+----------------------+----------------------------+ |
| Automatic Updates | If disabled, automatic Desktop App updates are disabled. | v5.1 or later | ``EnableAutoUpdates`` | |
+--------------------------+------------------------------------------------------------+----------------------+----------------------------+------------------+

**Disable automatic updates**
The following group policies are available supporting a state option of Not Configured, Enabled, or Disabled:

+--------------------------+------------------------------------------------------------+----------------------+----------------------------+
| Group policy | Description | Mattermost release | Setting |
+==========================+============================================================+======================+============================+
| Enable Server Management | If disabled, management of servers in the | v4.3 or later | ``EnableServerManagement`` |
| | app settings are disabled. | | |
| | | | |
+--------------------------+------------------------------------------------------------+----------------------+----------------------------+
| Default Server List | Define one or more default, permanent servers. | v4.3 or later | ``DefaultServerList`` |
+--------------------------+------------------------------------------------------------+----------------------+----------------------------+
| Automatic Updates | If disabled, automatic Desktop App updates are disabled. | v5.1 or later | ``EnableAutoUpdates`` |
+--------------------------+------------------------------------------------------------+----------------------+----------------------------+

**Disable automatic updates**

Automatic desktop app updates can be disabled by configuring the supported group policy. See the :doc:`MSI installer and group policy documentation </install/desktop-msi-installer-and-group-policy-install>` for instructions on installing the Mattermost Desktop App via an MSI installer, and configuring supported group policies. Changes to group policies require you to restart Mattermost for those changes to take effect.

Expand Down Expand Up @@ -292,6 +292,11 @@ Append ``Mattermost.exe;`` to the Registry Key ``HKLM\SYSTEM\CurrentControlSet\S

For further assistance, review the `Troubleshooting forum <https://forum.mattermost.com/c/trouble-shoot>`__ for previously reported errors, or `join the Mattermost user community for troubleshooting help <https://mattermost.com/pl/default-ask-mattermost-community/>`__.

Can I uninstall the desktop app I installed using snap on Linux?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Yes. Run the following command from a terminal window: ``sudo snap remove mattermost-desktop``.

Report Desktop App issues
-------------------------

Expand Down
4 changes: 4 additions & 0 deletions source/collaborate/join-leave-channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,10 @@ Leave a channel

When you leave a private channel, you must be re-added by another channel member to rejoin. You won't receive mention notifications from a channel if you're not a member of that channel.

.. note::

All users are added to the **Off-Topic** and **Town Square** channels automatically. Users can't :ref:`archive <collaborate/archive-unarchive-channels:archive a channel>`, :ref:`unarchive <collaborate/archive-unarchive-channels:unarchive a channel>`, or leave these channels.

.. tab:: Web/Desktop

Select the channel name at the top of the center pane to access the drop-down menu, then select **Leave Channel**.
Expand Down
2 changes: 2 additions & 0 deletions source/collaborate/organize-conversations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ Threads are a key part of the messaging experience in Mattermost. They're used t

Collapsed Reply Threads offers an enhanced experience for users communicating in threads and replying to messages that includes a unified threads inbox to read all conversations in one view. Threads improve the ability to process channel content, find, follow, and resume conversations more easily, and keep threaded conversations focused.

All Mattermost users can create new threads, unless the system admin has :ref:`disabled the ability to do so <configure/site-configuration-settings:collapsed reply threads>`.

.. image:: ../images/collapsed-reply-threads.gif
:alt: Organize conversations using Collapsed Reply Threads.

Expand Down
13 changes: 11 additions & 2 deletions source/comply/legal-hold.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,16 @@ Primary use cases include:

Mattermost is used as a secure collaboration hub by technical and operational teams, with critical documents and data shared on a daily basis. Thus, legal hold is a key requirement for Enterprises and public sector organizations who have deployed Mattermost for their teams, to meet compliance & auditory requirements while minimizing risk.

Below are step-by-step instructions on how to carry out a legal hold for Mattermost with XML-formatted data, Amazon S3 file storage, and archiving and compliance tools, such as `Smarsh <https://www.smarsh.com/>`__.
Legal hold demo (Sneak Peek)
----------------------------

Check out this `YouTube sneak peek demo <https://youtu.be/86c8NoOxlQw>`_ to learn about Mattermost's legal hold workflow.

.. raw:: html

<iframe width="560" height="315" src="https://www.youtube.com/embed/86c8NoOxlQw" alt="Mattermost legal hold workflow" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>

Below are step-by-step instructions on how to carry out a legal hold for Mattermost with XML-formatted data, Amazon S3 file storage, and archiving and compliance tools, such as `Smarsh <https://www.smarsh.com/>`_.

How to carry out a legal hold
-----------------------------
Expand Down Expand Up @@ -70,7 +79,7 @@ The exports include information on channel member history at the time the messag
3 - Leverage compliance API in your DLP tool of choice
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Connect it directly to the Amazon S3 bucket where compliance exports are stored. Our recommended DLP tool of choice is `Smarsh <https://www.smarsh.com/>`__. Learn more about their legal hold & e-discovery processes in their `documentation <https://www.smarsh.com/platform/enterprise/discovery>`__.
Connect it directly to the Amazon S3 bucket where compliance exports are stored. Our recommended DLP tool of choice is `Smarsh <https://www.smarsh.com/>`_. Learn more about their legal hold & e-discovery processes in their `documentation <https://www.smarsh.com/platform/enterprise/discovery>`_.

You may optionally also use other tools that connect with Amazon S3, such as Active360, AwareHQ, Onna, or Trellix, though our team will be able to provide limited support using these tools.

Expand Down
8 changes: 6 additions & 2 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -358,6 +358,10 @@ def setup(_: Sphinx):
"https://docs.mattermost.com/configure/site-configuration-settings.html#file-sharing-and-downloads",
"administration/config-settings.html#allow-untrusted-internal-connections-to":
"https://docs.mattermost.com/configure/environment-configuration-settings.html#allow-untrusted-internal-connections",
"administration/command-line-tools.html#mattermost-channel-delete":
"https://docs.mattermost.com/manage/mmctl-command-line-tool.html#mmctl-channel-delete",
"administration/mmctl-cli-tool.html#mmctl-channel-delete":
"https://docs.mattermost.com/manage/mmctl-command-line-tool.html#mmctl-channel-delete",
"administration/version-archive.html":
"https://docs.mattermost.com/upgrade/version-archive.html",

Expand Down Expand Up @@ -3360,9 +3364,9 @@ def setup(_: Sphinx):
# built documents.
#
# The short X.Y version.
# version = '9.6'
# version = '9.7'
# The full version, including alpha/beta/rc tags.
# release = '9.6'
# release = '9.7'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
7 changes: 7 additions & 0 deletions source/configure/calls-deployment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,13 @@ Some caveats apply here. Web socket events (for example: emoji reactions, hand r

In general, ``rtcd`` is the preferred solution for a performant and scalable deployment. With ``rtcd``, the Mattermost server will be minimally impacted when hosting a high number of calls.

See the `Mattermost rtcd repository documentation <https://github.com/mattermost/rtcd/blob/master/README.md>`__ on GitHub for details on `how to run calls through the service <https://github.com/mattermost/rtcd/blob/master/docs/getting_started.md>`__, as well as:

- `Key implementation details <https://github.com/mattermost/rtcd/blob/master/docs/implementation.md>`__
- `Project structure <https://github.com/mattermost/rtcd/blob/master/docs/project_structure.md>`__
- `Configuration overrides <https://github.com/mattermost/rtcd/blob/master/docs/env_config.md>`__
- `Authentication flow <https://github.com/mattermost/rtcd/blob/master/docs/security.md>`__

Horizontal scalability
~~~~~~~~~~~~~~~~~~~~~~

Expand Down
Loading

0 comments on commit 0012645

Please sign in to comment.