Cleaned up shared channel config deprecation

mattermost · Nov 15, 2024 · 8dd5235 · 8dd5235
1 parent 81c9bbc
commit 8dd5235
Show file tree

Hide file tree

Showing 6 changed files with 63 additions and 32 deletions.
diff --git a/source/conf.py b/source/conf.py
@@ -1889,7 +1889,10 @@ def setup(_: Sphinx):
         "https://docs.mattermost.com/configure/environment-configuration-settings.html#database",
 "configure/experimental-configuration-settings.html#enable-shared-channels":
         "https://docs.mattermost.com/configure/site-configuration-settings.html#enable-connected-workspaces",
-
+"configure/experimental-configuration-settings.rst#enable-shared-channels":
+        "https://docs.mattermost.com/configure/deprecated-configuration-settings.html#enable-shared-channels-experimental",
+"configure/experimental-configuration-settings.rst#remote-clusters":
+        "https://docs.mattermost.com/configure/deprecated-configuration-settings.html#enable-remote-cluster-service-experimental",
 
 # Deploy redirects
 "deploy/mobile-apps-faq.html":

diff --git a/source/configure/deprecated-configuration-settings.rst b/source/configure/deprecated-configuration-settings.rst
@@ -20,6 +20,7 @@ The following Mattermost configuration settings are deprecated and are no longer
 - `Image settings <#image-settings>`__
 - `Experimental display settings <#experimental-display-settings>`__
 - `Experimental API endpoint settings <#experimental-api-endpoint-settings>`__
+- `Shared channels settings <#shared-channels-settings>`__
 - `Other deprecated settings <#other-deprecated-settings>`__
 
 ----
@@ -783,6 +784,45 @@ The file must be in the same directory as your ``config.json`` file if you set a
 
 ----
 
+Shared channels settings
+------------------------
+
+Enable remote cluster service (Experimental)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Deprecated in November 16th, 2024 release in favor of :ref:`Connected Workspaces <configure/site-configuration-settings:enable connected workspaces>` configuration settings
+
+This setting isn't available in the System Console and can only be set in ``config.json``.
+
+Enable this setting to add, remove, and view remote clusters for shared channels.
+
+**True**: System admins can manage remote clusters using the System Console.
+
+**False**: (**Default**) Remote cluster management is disabled.
+
++---------------------------------------------------------------------------------------------------------------------------------------+
+| This feature's ``config.json`` setting is ``"ExperimentalSettings.EnableRemoteClusters": false`` with options ``true`` and ``false``. |
++---------------------------------------------------------------------------------------------------------------------------------------+
+
+Enable shared channels (Experimental)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Deprecated in November 16th, 2024 release in favor of :ref:`Connected Workspaces <configure/site-configuration-settings:enable connected workspaces>` configuration settings
+
+This setting isn't available in the System Console and can only be set in ``config.json``.
+
+Enable the ability to establish secure connections between Mattermost instances, and invite secured connections to shared channels where secure connections can participate as they would in any public and private channel.
+
+**True**: System admins can establish secure connections between Mattermost instances.
+
+**False**: (**Default**) The ability to establish secure connections is disabled.
+
++---------------------------------------------------------------------------------------------------------------------------------------+
+| This feature's ``config.json`` setting is ``"ExperimentalSettings.EnableSharedChannels": false`` with options ``true`` and ``false``. |
++---------------------------------------------------------------------------------------------------------------------------------------+
+
+----
+
 Other deprecated settings
 --------------------------
 
@@ -834,21 +874,4 @@ This configuration setting disables the ability to send inactivity email notific
 Disable Apps Bar
 ~~~~~~~~~~~~~~~~
 
-This setting is enabled for all customers by default from Mattermost v8.0. This setting disables the Apps Bar and moves all Mattermost integration icons from the vertical pane on the far right back to the channel header. 
-
-Remote clusters
-~~~~~~~~~~~~~~~
-
-*Deprecated in November 16th, 2024 release in favor of Connected Workspaces*
-
-This setting isn't available in the System Console and can only be set in ``config.json``.
-
-Enable this setting to add, remove, and view remote clusters for shared channels.
-
-**True**: System admins can manage remote clusters using the System Console.
-
-**False**: (**Default**) Remote cluster management is disabled.
-
-+------------------------------------------------------------------------------------------------------------+
-| This feature's ``config.json`` setting is ``"RemoteClusters": false`` with options ``true`` and ``false``. |
-+------------------------------------------------------------------------------------------------------------+
+This setting is enabled for all customers by default from Mattermost v8.0. This setting disables the Apps Bar and moves all Mattermost integration icons from the vertical pane on the far right back to the channel header. 
diff --git a/source/configure/reporting-configuration-settings.rst b/source/configure/reporting-configuration-settings.rst
@@ -29,7 +29,7 @@ Site statistics
 |                                                                                                                                      |
 | - Bots, deactivated users, and synthetic users in                                                                                    |
 |   :doc:`Microsoft Teams integrations </collaborate/collaborate-within-connected-microsoft-teams>`                                    |
-|   and :doc:`connected workspaces </onboard/connected-workspaces>` users aren't counted towards the total number of activated users.   |
+|   and :doc:`connected workspaces </onboard/connected-workspaces>` users aren't counted towards the total number of activated users.  |
 | - For billing purposes, activated guest accounts do consume a licensed seat, which is returned when the guest account is             |
 |   deactivated. This means that guest accounts count as a paid user in your Mattermost                                                |
 |   :doc:`workspace </guides/use-mattermost>`.                                                                                         |
@@ -44,15 +44,15 @@ Team statistics
 
  <p class="mm-label-note">Also available in legacy Mattermost Enterprise Edition E10 or E20</p>
 
-+---------------------------------------------------------------+---------------------------------------------------------------+
-| View statistics per team on number of activated users,        | - System Config path: **Reporting > Team Statistics**         |
-| number of public and private channels, total post count, and  | - ``config.json`` setting: N/A                                |
-| count of paid users (self-hosted only).                       | - Environment variable: N/A                                   |
-+---------------------------------------------------------------+---------------------------------------------------------------+
-| **Note**: Bots, deactivated users, and synthetic users in                                                                     |
-| :doc:`Microsoft Teams integrations </collaborate/collaborate-within-connected-microsoft-teams>`                               |
++---------------------------------------------------------------+----------------------------------------------------------------+
+| View statistics per team on number of activated users,        | - System Config path: **Reporting > Team Statistics**          |
+| number of public and private channels, total post count, and  | - ``config.json`` setting: N/A                                 |
+| count of paid users (self-hosted only).                       | - Environment variable: N/A                                    |
++---------------------------------------------------------------+----------------------------------------------------------------+
+| **Note**: Bots, deactivated users, and synthetic users in                                                                      |
+| :doc:`Microsoft Teams integrations </collaborate/collaborate-within-connected-microsoft-teams>`                                |
 | and :doc:`connected workspaces </onboard/connected-workspaces>` users aren't counted towards the total number of active users. |
-+---------------------------------------------------------------+---------------------------------------------------------------+
++---------------------------------------------------------------+----------------------------------------------------------------+
 
 ----
 

diff --git a/source/configure/site-configuration-settings.rst b/source/configure/site-configuration-settings.rst
@@ -1752,7 +1752,7 @@ Connected workspaces
 The following settings aren't available in the System Console and can only be set in ``config.json``. 
 When connected workspaces are enabled, system admins can :doc:`create and manage connected workspaces </onboard/connected-workspaces>` in the System Console by going to **Site Configuration > Connected Workspaces (Beta)**.
 
-.. config:setting:: enable-connected-workspace
+.. config:setting:: enable-connected-workspaces
   :displayname: Enable connected workspaces (Beta)
   :systemconsole: Site Configuration > Connected Workspaces (Beta)
   :configjson: ConnectedWorkspacesSettings.EnableSharedChannels, ConnectedWorkspacesSettings.EnableRemoteClusterService 
@@ -1772,8 +1772,9 @@ This feature's two ``config.json`` settings include:
 
 .. note::
 
-  - Neither setting is available in the System Console and can only be set in ``config.json``.
+  - Neither setting is available in the System Console and can only be set in ``config.json`` under ``ConnectedWorkspacesSettings``. 
   - System admins for Cloud deployments can submit a request to have these required configuration settings enabled for their Cloud deployment instance.
+  - Following an upgrade to Mattermost v10.2 or later, existing configuration values for shared channels, including ``EnableSharedChannels`` and ``EnableRemoteClusterService`` are automatically converted to :ref:`connected workspace configuration settings <configure/site-configuration-settings:enable connected workspaces>` in the ``config.json`` file. The :ref:`deprecated shared channels experimental settings <configure/deprecated-configuration-settings:shared channels settings>` remain in the ``config.json`` file to support backwards compatibility.
 
 .. config:setting:: disable-status-sync
   :displayname: Disable shared channel status sync

diff --git a/source/onboard/ad-ldap.rst b/source/onboard/ad-ldap.rst
@@ -281,7 +281,7 @@ To address this issue you can set the :ref:`max page size <configure/authenticat
 If the error is still occurring, it is likely that no AD/LDAP users have logged into Mattermost yet. Ensure that at least one AD/LDAP user has logged into Mattermost and re-run the synchronization. The error should disappear at that point.
 
 I see the log error ``Missing NameID Element``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 This indicates that the  AD/LDAP server configuration doesn't include the ``NameID`` element in the SAML assertion. The ``NameID`` element is required for user identification in SAML assertions. Ensure the ``NameID`` is mapped to a unique user identifier, such as the user's email address or another stable attribute that isn't subject to change over time.
 

diff --git a/source/onboard/connected-workspaces.rst b/source/onboard/connected-workspaces.rst
@@ -21,7 +21,7 @@ The process of connecting Mattermost workspaces involves the following 4 steps:
 
 1. Each system admin of a Mattermost instance who wants to connect to another Mattermost workspaces must `enable the connected workflows functionality <#enable-connected-workflows>`__.
 
-2. Using the System Console or slash commands, system admins create a secure and trusted connection with other Mattermost Enterprise instances. This process involves creating a password-protected, encrypted invitation, creating a strong decryption password, then sending the invitation and password to the system admin of a remote Mattermost instance.
+2. Using the System Console or slash commands, system admins `create a secure and trusted connection <#create-a-secure-connection>`__ with other Mattermost Enterprise instances. This process involves creating a password-protected, encrypted invitation, creating a strong decryption password, then sending the invitation and password to the system admin of a remote Mattermost instance.
 
 3. Using the System Console or slash commands, a remote system admin receives the invitation and `accepts the invitation <#accept-a-secure-connection-invitation>`__.
 
@@ -43,6 +43,10 @@ System admins must enable connected workspaces functionality for their Mattermos
 
 See the :ref:`Site Configuration Settings <configure/site-configuration-settings:enable connected workspaces>` documentation for details.
 
+.. note::
+
+    Following an upgrade to Mattermost v10.2 or later, existing configuration values for shared channels, including ``EnableSharedChannels`` and ``EnableRemoteClusterService`` are automatically converted to :ref:`connected workspace configuration settings <configure/site-configuration-settings:enable connected workspaces>` in the ``config.json`` file. The :ref:`deprecated shared channels experimental settings <configure/deprecated-configuration-settings:shared channels settings>` remain in the ``config.json`` file to support backwards compatibility.
+
 Create a secure connection
 ---------------------------