V9.3 documentation (#6794)

* Replaced manual page TOCs with code-generated TOCs (#6787) * Update conf.py * Added examples of MFA auth tools beyond Google (#6780) * Added Academy links & file storage health check (#6779) * Updated deploy badge & added Enteprise trial flag (#6775) * + Vietnamese as Beta; + Hungarian where missing (#6777) * + Vietnamese as Beta; + Hungarian where missing * Broken table syntax fix * marked mmctl integrity as deprecated from v9.3 (#6774) * Moved Apps Deploy pages out of /guides to /deploy (#6799) * Incorporated feedback re: prod Docker instance (#6798) * Removed ExperimentalTimezone (#6778) * Removed Allow prefetch channel posts (#6807) * Added max limit for emoji reactions (#6810) * Fixed build errors/warnings (#6809) * Added keyword highlighting docs (#6800) * Added keyword highlighting * Incorporated reviewer feedback * Incorporated reviewer feedback * Added animated GIFs * Added link to article on how to set up a quick Kubernetes evaluation deployment (#6782) * Added quick Kubernetes deploy for evaluation * Source file cleanup * Removed MySQL references & applied common styling * v9.3 Changelog (#6786) * Update mattermost-changelog.md * Update mattermost-changelog.md * Update mattermost-changelog.md * Update mattermost-changelog.md * Update open-source-components.rst * Update release-lifecycle.rst * Update software-hardware-requirements.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 source/deploy/mattermost-changelog.md Co-authored-by: Carrie Warner (Mattermost) <[email protected]> * 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 download-latest-tarball.rst --------- Co-authored-by: Carrie Warner (Mattermost) <[email protected]> * Update mattermost-changelog.md * Update mattermost-changelog.md --------- Co-authored-by: Carrie Warner (Mattermost) <[email protected]>
mattermost · Dec 15, 2023 · 0763563 · 0763563
1 parent 17f51ef
commit 0763563
Show file tree

Hide file tree

Showing 43 changed files with 491 additions and 101 deletions.
diff --git a/source/_static/badges/academy-channels.rst b/source/_static/badges/academy-channels.rst
@@ -0,0 +1,12 @@
+:orphan:
+:nosearch:
+
+.. raw:: html
+
+  <a href="https://mattermost.com/pl/mattermost-academy-channels-training" class="mm-badge mm-badge--academy" target="_blank">
+    <img src="../_static/images/badges/academy-callout-image.jpg" alt="" />
+    <div class="mm-badge__copy">
+      <span class="mm-badge__accent-text">Mattermost Academy</span>
+      <span class="mm-badge__title">Learn about Mattermost channels</span>
+    </div>
+  </a>
diff --git a/source/_static/badges/academy-file-storage.rst b/source/_static/badges/academy-file-storage.rst
@@ -7,6 +7,6 @@
     <img src="../_static/images/badges/academy-callout-image.jpg" alt="" />
     <div class="mm-badge__copy">
       <span class="mm-badge__accent-text">Mattermost Academy</span>
-      <span class="mm-badge__title">Learn about Mattermost file storage</span>
+      <span class="mm-badge__title">Learn about file storage</span>
     </div>
   </a>
diff --git a/source/about/editions-and-offerings.rst b/source/about/editions-and-offerings.rst
@@ -74,7 +74,7 @@ Features include:
 - `Granular system permissions </onboard/advanced-permissions.html>`__.
 - Highly customizable `third-party bots, integrations <https://mattermost.com/marketplace/#publicApps>`__, and `command line tools </manage/mmctl-command-line-tool.html>`__.
 - Extensive integration support via `webhooks, APIs, drivers <https://developers.mattermost.com/integrate/other-integrations/>`__, and `third-party extensions <https://mattermost.com/marketplace/>`__.
-- Multiple languages including English (Australian, US), Bulgarian, Chinese (Simplified and Traditional), Dutch, French, German, Italian, Japanese, Korean, Persian, Polish, Portuguese (Brazil), Romanian, Russian, Spanish, Swedish, Turkish, and Ukrainian.
+- Multiple languages including English (Australian, US), Bulgarian, Chinese (Simplified and Traditional), Dutch, French, German, Hungarian, Italian, Japanese, Korean, Persian, Polish, Portuguese (Brazil), Romanian, Russian, Spanish, Swedish, Turkish, Ukrainian, and Vietnamese.
 - `Community support <https://mattermost.com/support/>`__.
 
 See a complete list of features `here <https://mattermost.com/pricing>`__.

diff --git a/...install/common-prod-deploy-kubernetes.rst → ...archive/common-prod-deploy-kubernetes.rst b/...install/common-prod-deploy-kubernetes.rst → ...archive/common-prod-deploy-kubernetes.rst
diff --git a/source/collaborate/react-with-emojis-gifs.rst b/source/collaborate/react-with-emojis-gifs.rst
@@ -12,12 +12,12 @@ Emojis and GIFs are small, digital images, animated images, or icons you can use
 Quick emoji reactions
 -----------------------
 
-React to messages quickly with recently used emojis. Hover over a message to access recently used emojis. 
+Hover over a message to react quickly using your most recent emojis. You can react with up to 50 emojis per message.
 
     .. image:: ../images/recent-emojis.png
       :alt: React to messages quickly by selecting one of your most recently used emojis.
 
-Recently used emojis are sorted based on how often you've used them. 
+Recently used emojis are sorted based on how often you've used them.
 
 .. tip::
 

diff --git a/source/conf.py b/source/conf.py
@@ -2033,6 +2033,16 @@ def setup(_: Sphinx):
         "https://docs.mattermost.com/guides/preferences.html",
 "guides/welcome-to-mattermost.html#mattermost-interface-changes":
         "https://docs.mattermost.com/guides/deployment.html#changelogs",
+"guides/configure-app-framework.html":
+        "https://docs.mattermost.com/deploy/configure-app-framework",
+"guides/deploy-http.html":
+        "https://docs.mattermost.com//deploy/deploy-http",
+"guides/deploy-aws.html":
+        "https://docs.mattermost.com//deploy/deploy-aws",
+"guides/package-aws.html":
+        "https://docs.mattermost.com//deploy/package-aws",
+"guides/deploy-openfaas.html":
+        "https://docs.mattermost.com/deploy/deploy-openfaas",
 
 # Help redirects resulting from the June 2021 docs reorganization project.
 "help/apps/desktop-changelog.html":
@@ -3311,9 +3321,9 @@ def setup(_: Sphinx):
 # built documents.
 #
 # The short X.Y version.
-# version = '9.2'
+# version = '9.3'
 # The full version, including alpha/beta/rc tags.
-# release = '9.2'
+# release = '9.3'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/source/configure/developer-mode-configuration-settings.rst b/source/configure/developer-mode-configuration-settings.rst
@@ -71,8 +71,8 @@ Enable client debugging
 
 +---------------------------------------------------+---------------------------------------------------------------------------------------------+
 | Enable or disable client-side debugging settings  | - System Config path: **Environment > Developer**                                           |
-| found in *Settings > Advanced > Debugging* for    | - ``config.json setting``: ``".ServiceSettings.EnableClientPerformanceDebugging": false",`` |
-| individual users.                                 | - Environment variable: ``MM_SERVICESETTINGS_ENABLECLIENTPERFORMANCEDEBUGGING``             |
+| found in **Settings > Advanced > Debugging**      | - ``config.json setting``: ``".ServiceSettings.EnableClientPerformanceDebugging": false",`` |
+| for individual users.                             | - Environment variable: ``MM_SERVICESETTINGS_ENABLECLIENTPERFORMANCEDEBUGGING``             |
 |                                                   |                                                                                             |
 | - **true**: Those settings are visible and can    |                                                                                             |
 |   be enabled by users.                            |                                                                                             |

diff --git a/source/configure/optimize-your-workspace.rst b/source/configure/optimize-your-workspace.rst
@@ -39,6 +39,10 @@ The following optimization areas can alert you to workspace suggestions, warning
 |                       |                                                                                                          |                                                                                                                                                                      |
 |                       | - **Session Length**: The default value may not provide an optimal user experience.                      | - `Set up SSL </onboard/ssl-client-certificate.html>`__                                                                                                              |
 |                       |                                                                                                          | - `Configure session length </configure/configuration-settings.html#session-lengths>`__                                                                              |
+|                       | - **File Storage**: Write access to the configured file storage location is required.                    | - `Configure file storage </configure/environment-configuration-settings.html#file-storage>`__                                                                       |
+|                       |                                                                                                          |                                                                                                                                                                      |
+|                       | .. include:: ../_static/badges/academy-file-storage.rst                                                  |                                                                                                                                                                      |
+|                       |    :start-after: :nosearch:                                                                              |                                                                                                                                                                      |
 +-----------------------+----------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | Workspace access      | Is the Mattermost workspace may not be accessible to users?                                              | If your web server settings don't pass a live URL test, your workspace may not be accessible to others.                                                              |
 |                       |                                                                                                          | See the `Environment Configuration Settings </configure/configuration-settings.html#environment>`__ product documentation to learn more:                             |

diff --git a/source/configure/site-configuration-settings.rst b/source/configure/site-configuration-settings.rst
@@ -347,10 +347,10 @@ Default server language
 +--------------------------------------------------------------------------------+---------------------------------------------------------------------------+
 | The default language for system messages and logs.                             | - System Config path: **Site Configuration > Localization**               |
 |                                                                                | - ``config.json`` setting: ``.LocalizationSettings.DefaultServerLocale``  |
-| Options: ``"bg"``, ``"de"``, ``"en"``, ``en-AU``, ``"es"``, ``"fa"``,          | - Environment variable: ``MM_LOCALIZATIONSETTINGS_DEFAULTSERVERLOCALE``   |
+| Options: ``"bg"``, ``"de"``, ``"en"``, ``"en-AU"``, ``"es"``, ``"fa"``,        | - Environment variable: ``MM_LOCALIZATIONSETTINGS_DEFAULTSERVERLOCALE``   |
 | ``"fr"``, ``"hu"``, ``"it"``, ``"ja"``, ``"ko"``, ``"nl"``, ``"pl"``,          |                                                                           |
-| ``"pt-br"``, ``"ro"``, ``"ru"``, ``"sv"``, ``"tr"``, ``uk``, ``"zh_CN"``,      |                                                                           |
-| and ``"zh_TW"``.                                                               |                                                                           |
+| ``"pt-br"``, ``"ro"``, ``"ru"``, ``"sv"``, ``"tr"``, ``"uk"``, ``"vi"``,       |                                                                           |
+| ``"zh_CN"``, and ``"zh_TW"``.                                                  |                                                                           |
 |                                                                                |                                                                           |
 | Default is ``"en"``.                                                           |                                                                           |
 +--------------------------------------------------------------------------------+---------------------------------------------------------------------------+
@@ -368,10 +368,10 @@ Default client language
 +--------------------------------------------------------------------------------+---------------------------------------------------------------------------+
 | The default language for new users and pages where the user isn't logged in.   | - System Config path: **Site Configuration > Localization**               |
 |                                                                                | - ``config.json`` setting: ``.LocalizationSettings.DefaultClientLocale``  |
-| Options: ``"bg"``, ``"de"``, ``"en"``, ``en-AU``, ``"es"``, ``"fa"``,          | - Environment variable: ``MM_LOCALIZATIONSETTINGS_DEFAULTCLIENTLOCALE``   |
+| Options: ``"bg"``, ``"de"``, ``"en"``, ``"en-AU"``, ``"es"``, ``"fa"``,        | - Environment variable: ``MM_LOCALIZATIONSETTINGS_DEFAULTCLIENTLOCALE``   |
 | ``"fr"``, ``"hu"``, ``"it"``, ``"ja"``, ``"ko"``, ``"nl"``, ``"pl"``,          |                                                                           |
-| ``"pt-br"``, ``"ro"``, ``"ru"``, ``"sv"``, ``"tr"``, ``uk``, ``"zh_CN"``,      |                                                                           |
-| and ``"zh_TW"``.                                                               |                                                                           |
+| ``"pt-br"``, ``"ro"``, ``"ru"``, ``"sv"``, ``"tr"``, ``"uk"``, ``"vi"``,       |                                                                           |
+| ``"zh_CN"``, and ``"zh_TW"``.                                                  |                                                                           |
 |                                                                                |                                                                           |
 | Default is ``"en"``.                                                           |                                                                           |
 +--------------------------------------------------------------------------------+---------------------------------------------------------------------------+
@@ -394,10 +394,10 @@ Available languages
 | in addition to any other languages. For example, to limit the language         |                                                                           |
 | choices to US English and Español (es), the string would be ``”en,es”``.       |                                                                           |
 |                                                                                |                                                                           |
-| Options: ``"bg"``, ``"de"``, ``"en"``, ``en-AU``, ``"es"``, ``"fa"``,          |                                                                           |
+| Options: ``"bg"``, ``"de"``, ``"en"``, ``"en-AU"``, ``"es"``, ``"fa"``,        |                                                                           |
 | ``"fr"``, ``"hu"``, ``"it"``, ``"ja"``, ``"ko"``, ``"nl"``, ``"pl"``,          |                                                                           |
-| ``"pt-br"``, ``"ro"``, ``"ru"``, ``"sv"``, ``"tr"``, ``uk``, ``"zh_CN"``,      |                                                                           |
-| and ``"zh_TW"``.                                                               |                                                                           |
+| ``"pt-br"``, ``"ro"``, ``"ru"``, ``"sv"``, ``"tr"``, ``"uk"``, ``"vi"``,       |                                                                           |
+| ``"zh_CN"``, and ``"zh_TW"``.                                                  |                                                                           |
 |                                                                                |                                                                           |
 | Default is ``"en"``.                                                           |                                                                           |
 +--------------------------------------------------------------------------------+---------------------------------------------------------------------------+

diff --git a/source/guides/configure-app-framework.rst → source/deploy/configure-app-framework.rst b/source/guides/configure-app-framework.rst → source/deploy/configure-app-framework.rst
diff --git a/source/guides/deploy-aws.rst → source/deploy/deploy-aws.rst b/source/guides/deploy-aws.rst → source/deploy/deploy-aws.rst
@@ -8,7 +8,7 @@ An App designed and bundled for AWS Lambda can be deployed to the customer's own
 AWS environment, and then installed on a self-managed ("on-prem") Mattermost
 instance. Note that the only AWS-hosted apps available on Mattermost Cloud instances are the ones by Mattermost.
 
-For details on how to develop and package apps for AWS see `Package / AWS <package-aws.html>`_.
+For details on how to develop and package apps for AWS see `Package / AWS </deploy/package-aws.html>`__.
 
 There are three steps required to enable AWS applications on a self-managed Mattermost instance.
 
@@ -34,7 +34,7 @@ You will need to create an S3 bucket within AWS or use an existing bucket.
 Create a privileged IAM user access key and secret
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-You will need an access key and secret so that ``appsctl`` can deploy the app. These credentials can come from creating an IAM user, using a privileged IAM user, or even using the AWS account owners personal access key. Please follow the instructions provided by AWS (https://aws.amazon.com/premiumsupport/knowledge-center/create-access-key/) to complete these steps and save the ``Access key ID`` and ``Secret access key`` values.
+You will need an access key and secret so that ``appsctl`` can deploy the app. These credentials can come from creating an IAM user, using a privileged IAM user, or even using the AWS account owners personal access key. Please follow the `instructions provided by AWS <https://aws.amazon.com/premiumsupport/knowledge-center/create-access-key/>`__ to complete these steps and save the ``Access key ID`` and ``Secret access key`` values.
 
 Set AWS_DEPLOY environment variables
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -134,7 +134,7 @@ The ``manifest.json`` file of an app is stored in the same S3 bucket with the ke
 Deploy ustom apps to AWS
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. image:: deploy-third-party-aws.png
+.. image:: /images/deploy-third-party-aws.png
    :width: 800
 
 Deployment in Mattermost Cloud
@@ -149,7 +149,7 @@ The deployer needs lambda function names, asset keys, and the manifest key to de
 Deploy custom apps to AWS
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. image:: deploy-mm-aws.png
+.. image:: /images/deploy-mm-aws.png
    :width: 800
 
 .. |Mattermost apps cloud deployer| raw:: html

diff --git a/source/guides/deploy-http.rst → source/deploy/deploy-http.rst b/source/guides/deploy-http.rst → source/deploy/deploy-http.rst
diff --git a/source/guides/deploy-mattermost-apps.rst → source/deploy/deploy-mattermost-apps.rst b/source/guides/deploy-mattermost-apps.rst → source/deploy/deploy-mattermost-apps.rst
@@ -6,17 +6,17 @@ App deployment
    :hidden:
    :titlesonly:
 
-    Settings </guides/configure-app-framework>
-    HTTP </guides/deploy-http>
-    AWS </guides/deploy-aws>
-    Package Apps for AWS </guides/package-aws>
-    OpenFaaS </guides/deploy-openfaas>
+    Settings </deploy/configure-app-framework>
+    HTTP </deploy/deploy-http>
+    AWS </deploy/deploy-aws>
+    Package Apps for AWS </deploy/package-aws>
+    OpenFaaS </deploy/deploy-openfaas>
 
 - In **Mattermost Cloud**, all apps are deployed to the Marketplace by Mattermost staff. They can be installed onto a specific Mattermost instance using the ``/apps install listed`` command. No special configuration is required; the ``/apps install`` command should be enabled and functional by default.
 
-- **Self-managed Mattermost** installations can use external Apps as HTTP services that have already been deployed, or can deploy App bundles on self-managed hosting or serverless platforms. Currently, `AWS Lambda <deploy-aws>`_, `OpenFaaS <deploy-openfaas>`_, and Kubeless deployments are supported. The `appsctl` command can be used to deploy app bundles to these environments.
+- **Self-managed Mattermost** installations can use external Apps as HTTP services that have already been deployed, or can deploy App bundles on self-managed hosting or serverless platforms. Currently, `AWS Lambda </deploy/deploy-aws>`__, `OpenFaaS </deploy/deploy-openfaas>`__, and Kubeless deployments are supported. The `appsctl` command can be used to deploy app bundles to these environments.
 
-  Self-managed customers can also install external `HTTP <deploy-http>`_ apps, with no need to deploy them.
+  Self-managed customers can also install external `HTTP </deploy/deploy-http>`__ apps, with no need to deploy them.
 
   The ``appsctl`` CLI tool is provided to deploy AWS and OpenFaaS apps in self-managed environments. To install ``appsctl``, use the following command:
 

diff --git a/source/guides/deploy-openfaas.rst → source/deploy/deploy-openfaas.rst b/source/guides/deploy-openfaas.rst → source/deploy/deploy-openfaas.rst
diff --git a/source/deploy/deprecated-features.rst b/source/deploy/deprecated-features.rst
@@ -3,6 +3,10 @@ Removed and deprecated features for Mattermost
 
 This page describes features that are removed from support for Mattermost, or will be removed in a future update (deprecated), and provides early notice about future changes that might affect your use of Mattermost. This information is subject to change with future releases, and might not include each deprecated feature.
 
+.. contents:: On this page
+    :backlinks: top
+    :depth: 3
+
 Removed features in upcoming versions
 -------------------------------------
 

diff --git a/source/deploy/desktop-app-changelog.rst b/source/deploy/desktop-app-changelog.rst
@@ -1,17 +1,11 @@
 Desktop application changelog
 ==============================
 
-.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
-  :start-after: :nosearch:
+This changelog summarizes updates to Mattermost desktop app releases for `Mattermost <https://mattermost.com>`__.
 
-Latest Mattermost Desktop App releases:
-
-- `Release v5.5 <#id1>`_
-- `Release v5.4 <#id3>`_
-- `Release v5.3 <#id15>`_
-- `Release v5.2 <#id28>`_
-- `Release v5.1 <#id44>`_
-- `Release v5.0 <#id59>`_
+.. contents:: On this page
+    :backlinks: top
+    :depth: 2
 
 Release v5.5
 --------------