Skip to content

Commit

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

* Clarified that 1000 guidance is for 100-1000 concurrent users (#7112)

* Added 5M message limit (#7114)

* Added --local to example & updated formatting (#7115)

* Added Elasticsearch > Rebuild channels index option for admins (#7116)

* Added 2 new Amazon S3 upload/export part size config settings (#7125)

* Added Amazon S3 upload/export part size config settings

* second config setting

* Incorporated reviewer feedback

* User is notified if @mention isn't part of team (#7118)

* Aligned docs with updated user experience for notification preferences (#7119)

* Incorporated #7102 into v9.8 (#7120)

* Added Don't Clear DND option (#7121)

* Deprecated MaxIdleConns config setting (#7122)

* Clarified that roles & permissions schemes can be exported (#7123)

* Added new flags to mmctl import process (#7126)

* Updated section title to clarify action (#7128)

* Incorporates feature labels with existing content (#7129)

* Incorporates feature labels with existing content

* Final content iterations; removed duplication

* Removed Gfycat references (#7117)

* Removed Gfycat references

* Removed remaining gfycat references

* Added max payload size config setting (#7127)

* Added max payload size config setting

* Update source/configure/file-storage-configuration-settings.rst

Co-authored-by: Harshil Sharma <18575143+harshilsharma63@users.noreply.github.com>

* Incorporated reviewer feedback

* Table syntax fix

---------

Co-authored-by: Harshil Sharma <18575143+harshilsharma63@users.noreply.github.com>

* Code references to pgLoader corrected to pgloader (#7113)

* code references to pgLoader corrected to pgloader

* Converted remaining instances of pgLoader to lowercase l

* Build warning/error fixes

* v9.8 changelog (#7082)

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update open-source-components.rst

* Update release-lifecycle.rst

* Update download-latest-tarball.rst

* Update important-upgrade-notes.rst

* Update prepare-to-upgrade-mattermost.rst

* Update extended-support-release.rst

* Update version-archive.rst

* Add files via upload

* Update extended-support-release.rst

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update source/deploy/mattermost-changelog.md

Co-authored-by: Maria A Nunez <maria.nunez@mattermost.com>

* Update source/deploy/mattermost-changelog.md

Co-authored-by: Maria A Nunez <maria.nunez@mattermost.com>

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update software-hardware-requirements.rst

* Apply suggestions from code review

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

* Update mattermost-changelog.md

* Update mattermost-changelog.md

* Update mattermost-changelog.md

---------

Co-authored-by: Maria A Nunez <maria.nunez@mattermost.com>
Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

---------

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>
Co-authored-by: Harshil Sharma <18575143+harshilsharma63@users.noreply.github.com>
Co-authored-by: Maria A Nunez <maria.nunez@mattermost.com>
  • Loading branch information
4 people committed May 16, 2024
1 parent a201763 commit 826c62c
Show file tree
Hide file tree
Showing 48 changed files with 796 additions and 534 deletions.
29 changes: 2 additions & 27 deletions source/about/faq-product.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,36 +85,11 @@ The following chart highlights the end user features of Mattermost and their sup
"User profile settings", "X", "X", "X"
"Channel settings", "X", "X", "X"

.. _feature-quality-levels:

What feature quality levels does Mattermost have?
--------------------------------------------------

We strive to release viable features. This means that we put in a significant amount of effort to ensure we solve a use case with a high bar for quality. A feature that's viable and meets our criteria for our production quality levels will be released to production.

However, when working on large and complex features or new products, we may need to test them with a high volume of customers and users. For these scenarios, we'll release them as experimental or beta and implement feature flags and/or A/B testing to validate the effectiveness of features prior to production-level release.

We dogfood our features on our community server and provide many configuration options that ensure customers can opt-in when trying experimental or beta features.

This list describes the quality levels of Mattermost features, and what can be expected at each level.

Production Level Quality
- Recommended for use in production environments
- Eligible for commercial support by `Mattermost, Inc. <https://mattermost.com/support/>`__
- Detailed documentation is available
- Tested on several platforms

Beta Level Quality
- Support best effort only. `Premier Support <https://mattermost.com/support/>`__ is recommended for use in production environments
- Core functionality is stable, but iteration based on feedback is ongoing
- Full testing of all edge cases is still in progress
- Detailed documentation may not be available yet

Experimental Level Quality
- Not recommended for use in production
- Unknown level of stability
- Feature set covers a small or specific set of use cases. Additional use and edge cases will be added over time
- Data loss can occur as data schemas and configurations may change
- Minimal documentation is available
However, when working on large and complex features or new products, we may need to test them with a high volume of customers and users. For these scenarios, we'll release them as :ref:`Experimental <getting-started/feature-labels:experimental>` or :ref:`Beta <getting-started/feature-labels:beta>`, and implement feature flags and/or A/B testing to validate the effectiveness of features prior to production-level release. Additionally, we `dogfood our features <https://en.wikipedia.org/wiki/Eating_your_own_dog_food>`_ on our community server, and provide many configuration options that ensure customers can opt-in when trying experimental or beta features.

Please see our `handbook <https://handbook.mattermost.com/operations/research-and-development/processes/feature-labels>`__ for a more detailed explanation of how we define feature labels.
See the :doc:`Mattermost feature labels </getting-started/feature-labels>` documentation for details on the status, maturity, and support level of each feature, and what you can expect at each level.
6 changes: 3 additions & 3 deletions source/collaborate/install-desktop-app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ You can download the `desktop app <https://mattermost.com/apps/>`_ directly from
1. Download the latest version of the Mattermost desktop app: `32/64-bit version of Windows <https://releases.mattermost.com/desktop/5.7.0/mattermost-desktop-setup-5.7.0-win.exe>`_
2. From the **\Downloads** folder, right-click on the file ``mattermost-desktop-setup-5.7.0-win.exe``, then select **Open** to start an installer for the app. Once finished, the Mattermost desktop app opens automatically.

**MSI Installer and group policies (beta)**
**MSI Installer and group policies (Beta)**

You can download the latest version of the Mattermost desktop app MSI installer (Beta):

Expand Down Expand Up @@ -83,7 +83,7 @@ You can download the `desktop app <https://mattermost.com/apps/>`_ directly from

.. tab:: Ubuntu/Debian

Both a beta ``.deb`` package and an official APT repository is available for Debian 9 and for Ubuntu releases 20.04 LTS or later. Automatic app updates are supported and enabled. When a new version of the desktop app is released, your app updates automatically.
Both a ``.deb`` package (Beta), and an official APT repository is available for Debian 9 and for Ubuntu releases 20.04 LTS or later. Automatic app updates are supported and enabled. When a new version of the desktop app is released, your app updates automatically.

1. At the command line, set up the Mattermost repository on your system:

Expand Down Expand Up @@ -164,7 +164,7 @@ You can download the `desktop app <https://mattermost.com/apps/>`_ directly from

.. tab:: Generic Linux

A beta AppImage distribution of a compressed tarball is available. Automatic app updates are supported and enabled. When a new version of the desktop app is released, your app updates automatically.
A AppImage distribution (Beta) of a compressed tarball is available. Automatic app updates are supported and enabled. When a new version of the desktop app is released, your app updates automatically.

1. Download the latest version of the Mattermost desktop app:

Expand Down
2 changes: 1 addition & 1 deletion source/collaborate/mention-people.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The following example sends a special mention notification to Alice, whose usern
@alice how did your interview go with the new candidate?
If the person you mentioned doesn't belong to the channel, a system message is posted to let you know, and you're given the option to add the person to the channel. You are the only one who can see this message.
If the person you mentioned doesn't belong to the channel or the team, a system message is posted to let you know, and you're given the option to add the person to the channel. You are the only one who can see this message.

@channel and @all
-----------------
Expand Down
2 changes: 1 addition & 1 deletion source/collaborate/message-priority.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Set message priority (beta)
Set message priority (Beta)
===========================

.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
Expand Down
2 changes: 1 addition & 1 deletion source/collaborate/organize-conversations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Known issues

Collapsed Reply Threads was released as generally available in Mattermost v7.0, including significant server performance improvements and more flexible configuration options for system admins to enable the feature by default. We highly recommended :doc:`upgrading to Mattermost v7.0 </upgrade/upgrading-mattermost-server>` to take advantage of these configuration and performance enhancements.

Customers running Collapsed Reply Threads in beta on Mattermost v6.7 or earlier will likely experience bugs and unoptimized server performance. Learn more about the `beta release performance considerations <https://support.mattermost.com/hc/en-us/articles/4413183568276>`__ applicable only to Mattermost v5.37 through v6.7 deployments.
Customers running Collapsed Reply Threads in Beta running Mattermost v6.7 or earlier will likely experience bugs and unoptimized server performance. Learn more about the `beta release performance considerations <https://support.mattermost.com/hc/en-us/articles/4413183568276>`__ applicable only to Mattermost v5.37 through v6.7 deployments.

In particular, please be aware of these important known issues and risks:

Expand Down
4 changes: 2 additions & 2 deletions source/collaborate/organize-using-custom-user-groups.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Manage custom groups (beta)
Manage custom groups (Beta)
===========================

.. include:: ../_static/badges/ent-pro-cloud-selfhosted.rst
Expand All @@ -16,7 +16,7 @@ Manage custom groups (beta)

<p class="mm-label-note">Not available in legacy Mattermost Enterprise Edition E10 or E20</p>

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

Expand Down
12 changes: 8 additions & 4 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -1611,9 +1611,9 @@ def setup(_: Sphinx):
"configure/configuration-settings.html#enable-gif-picker":
"https://docs.mattermost.com/configure/integrations-configuration-settings.html#enable-gif-picker",
"configure/configuration-settings.html#gfycat-api-key":
"https://docs.mattermost.com/configure/integrations-configuration-settings.html#gfycat-api-key",
"https://docs.mattermost.com/configure/integrations-configuration-settings.html#gif-beta",
"configure/configuration-settings.html#gfycat-api-secret":
"https://docs.mattermost.com/configure/integrations-configuration-settings.html#gfycat-api-secret",
"https://docs.mattermost.com/configure/integrations-configuration-settings.html#gif-beta",
"configure/configuration-settings.html#enable-cross-origin-requests-from":
"https://docs.mattermost.com/configure/integrations-configuration-settings.html#enable-cross-origin-requests-from",
"configure/configuration-settings.html#cors-exposed-headers":
Expand Down Expand Up @@ -1804,6 +1804,8 @@ def setup(_: Sphinx):
"https://docs.mattermost.com/configure/configuration-in-your-database.html",
"configure/configuration-in-your-database.html":
"https://docs.mattermost.com/configure/store-configuration-in-your-database.html",
"configure/environment-configuration-settings.html#database-maxidleconnections":
"https://docs.mattermost.com/configure/deprecated-configuration-settings.html#database-maxidleconnections",

# Deploy redirects
"deploy/mobile-apps-faq.html":
Expand Down Expand Up @@ -2959,6 +2961,8 @@ def setup(_: Sphinx):
"https://docs.mattermost.com/onboard/migrating-to-mattermost.html#use-the-mattermost-web-app-deprecated",
"onboard/migrating-to-mattermost.html#migrating-from-slack-using-the-mattermost-mmetl-tool-and-bulk-import":
"https://docs.mattermost.com/onboard/migrating-to-mattermost.html#use-the-mattermost-mmetl-tool-and-bulk-import",
"onboard/migrating-to-mattermost.html#migrate-mattermost-server":
"https://docs.mattermost.com/onboard/migrate-mattermost-from-one-server-to-another",

# Overview redirects
"overview/architecture.html":
Expand Down Expand Up @@ -3414,9 +3418,9 @@ def setup(_: Sphinx):
# built documents.
#
# The short X.Y version.
# version = '9.7'
# version = '9.8'
# The full version, including alpha/beta/rc tags.
# release = '9.7'
# release = '9.8'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
32 changes: 10 additions & 22 deletions source/configure/calls-deployment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,7 @@ Calls self-hosted deployment
.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
:start-after: :nosearch:

This document provides information on how to successfully make the Calls plugin work on self-hosted deployments. It also outlines some of the most common deployment strategies with example diagrams, and also provides the deployment guidelines for the recording and transcription service.

- `Terminology <#terminology>`__
- `Plugin components <#plugin-components>`__
- `Requirements <#requirements>`__
- `Limitations <#limitations>`__
- `Configuration <#configuration>`__
- `Performance <#performance>`__
- `RTCD Service <#the-rtcd-service>`__
- `Configure recording and transcriptions <#configure-recording-and-transcriptions>`__
- `Kubernetes deployments <#kubernetes-deployments>`__
- `Frequently asked questions <#frequently-asked-questions>`__
- `Troubleshooting <#troubleshooting>`__
This document provides information on how to successfully make the Calls plugin work on self-hosted deployments. It also outlines some of the most common deployment strategies with example diagrams, and provides the deployment guidelines for the recording, transcription, and live captions service.

Terminology
-----------
Expand Down Expand Up @@ -329,28 +317,29 @@ In order for this to work, the :ref:`RTCD Service URL <configure/plugins-configu
The expected requirements are the following:

- When a new ``rtcd`` instance is deployed, it should be added to the DNS record. The plugin side will then be able to pick it up and start assigning calls to the new host.

- If a ``rtcd`` instance goes down, it should be removed from the DNS record. The plugin side can then detect the change and stop assigning new calls to that host.

.. note::
Load balancing is done at the call level. This means that a single call will always live on a single ``rtcd`` instance.
There's currently no support for spreading sessions belonging to the same call across a fleet of instances.
- Load balancing is done at the call level. This means that a single call will always live on a single ``rtcd`` instance.
- There's currently no support for spreading sessions belonging to the same call across a fleet of instances.

Configure recording and transcriptions
--------------------------------------
Configure recording, transcriptions, and live captions
------------------------------------------------------

Before you can start recording and transcribing calls, you need to configure the ``calls-offloader`` job service. You can read about how to do that `here <https://github.com/mattermost/calls-offloader/blob/master/docs/getting_started.md>`__. Performance and scalability recommendations related to this service can be found in `here <https://github.com/mattermost/calls-offloader/blob/master/docs/performance.md>`__.
Before you can start recording, transcribing, and live captioning calls, you need to configure the ``calls-offloader`` job service. See the `calls-offloader <https://github.com/mattermost/calls-offloader/blob/master/docs/getting_started.md>`_ documentation on GitHub for details on deploying and running this service. `Performance and scalability recommendations <https://github.com/mattermost/calls-offloader/blob/master/docs/performance.md>`_ related to this service are also available on GitHub.

.. note::
If deploying the service in a Kubernetes cluster, refer to the later section on `Helm charts <#helm-charts>`__.

Once the ``calls-offloader`` service is running, recordings should be explicitly enabled through the :ref:`Enable call recordings <configure/plugins-configuration-settings:enable call recordings (beta)>` config setting and the service's URL should be configured using :ref:`Job service URL <configure/plugins-configuration-settings:job service url>`.

Call transcriptions can be enabled through the :ref:`Enable call transcriptions <configure/plugins-configuration-settings:enable call transcriptions (experimental)>` configuration setting.

Call transcriptions can be enabled through the :ref:`Enable call transcriptions <configure/plugins-configuration-settings:enable call transcriptions (experimental)>` config setting.
Live captions can be enabled through the :ref:`Enable live captions <configure/plugins-configuration-settings:enable live captions (experimental)>` configuration setting.

.. note::
The call transcriptions functionality is available starting in Calls version v0.22.0
- The call transcriptions functionality is available starting in Calls version v0.22.0.
- The live captions functionality is available starting in Calls version v0.26.2.

Kubernetes deployments
----------------------
Expand Down Expand Up @@ -427,7 +416,6 @@ If calls are failing to connect or timing out, it's likely there could be a misc

For example, the :ref:`RTC Server Port (UDP) <configure/plugins-configuration-settings:rtc server port (udp)>` or the :ref:`RTC Server Port (TCP) <configure/plugins-configuration-settings:rtc server port (tcp)>` may not be open or forwarded correctly.


Connectivity checks
^^^^^^^^^^^^^^^^^^^

Expand Down
21 changes: 0 additions & 21 deletions source/configure/database-configuration-settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -148,27 +148,6 @@ Data source
| `high availablility database configuration </scale/high-availability-cluster.html#database-configuration>`__ documentation for details. |
+------------------------------------------------------------+-----------------------------------------------------------------------------+

.. config:setting:: database-maxidleconnections
:displayname: Maximum idle database connections (Database)
:systemconsole: Environment > Database
:configjson: SqlSettings.MaxIdleConns
:environment: MM_SQLSETTINGS_MAXIDLECONNS
:description: The maximum number of idle connections held open to the database. Default is **20**.

Maximum idle database connections
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. raw:: html

<p class="mm-label-note">Also available in legacy Mattermost Enterprise Edition E10 or E20</p>

+--------------------------------------------------------+------------------------------------------------------------------+
| The maximum number of idle connections held open | - System Config path: **Environment > Database** |
| to the database. | - ``config.json`` setting: ``".SqlSettings.MaxIdleConns": 20,`` |
| | - Environment variable: ``MM_SQLSETTINGS_MAXIDLECONNS`` |
| Numerical input. Default is **20**. | |
+--------------------------------------------------------+------------------------------------------------------------------+

.. config:setting:: database-maxopenconnections
:displayname: Maximum open connections (Database)
:systemconsole: Environment > Database
Expand Down
12 changes: 12 additions & 0 deletions source/configure/deprecated-configuration-settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -381,6 +381,18 @@ The port used for streaming data between servers.
| This feature's ``config.json`` setting is ``"StreamingPort": ":8075"`` with string input. |
+-------------------------------------------------------------------------------------------+

Maximum idle database connections
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

*Deprecated. Not used in Mattermost v7.0 and later*

+--------------------------------------------------------+------------------------------------------------------------------+
| The maximum number of idle connections held open | - System Config path: **Environment > Database** |
| to the database. | - ``config.json`` setting: ``".SqlSettings.MaxIdleConns": 20,`` |
| | - Environment variable: ``MM_SQLSETTINGS_MAXIDLECONNS`` |
| Numerical input. Default is **20**. | |
+--------------------------------------------------------+------------------------------------------------------------------+

Maximum idle connections for high availability
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down

0 comments on commit 826c62c

Please sign in to comment.