Connected workspaces rewrites & updates for Beta release (#7575)

* Connected workspaces rewrites & updates for Beta release * Added config settings, page redirects * Update source/conf.py * Update source/configure/reporting-configuration-settings.rst Co-authored-by: Miguel de la Cruz <[email protected]> * Update source/configure/reporting-configuration-settings.rst Co-authored-by: Miguel de la Cruz <[email protected]> * Update source/configure/site-configuration-settings.rst Co-authored-by: Miguel de la Cruz <[email protected]> * Update source/configure/site-configuration-settings.rst Co-authored-by: Miguel de la Cruz <[email protected]> * Update source/onboard/connected-workspaces.rst Co-authored-by: Miguel de la Cruz <[email protected]> * Update source/configure/site-configuration-settings.rst Co-authored-by: Miguel de la Cruz <[email protected]> * Added telemetry and deprecated remote cluster config * Updated default value --------- Co-authored-by: Miguel de la Cruz <[email protected]>
mattermost · Nov 14, 2024 · 8915cf7 · 8915cf7
1 parent 85b8bcd
commit 8915cf7
Show file tree

Hide file tree

Showing 12 changed files with 422 additions and 276 deletions.
diff --git a/source/about/editions-and-offerings.rst b/source/about/editions-and-offerings.rst
@@ -70,7 +70,7 @@ This offering includes all the features of `Mattermost Professional <#mattermost
 - :doc:`Advanced configuration of playbook permissions, and analytics dashboards </repeatable-processes/share-and-collaborate>`
 - :doc:`Channel export </comply/export-mattermost-channel-data>`
 - :ref:`Enhanced compliance controls and granular audit logs with data export <manage/logging:audit logging (beta)>`.
-- :doc:`Advanced collaboration with shared channels across Mattermost instances </onboard/shared-channels>`.
+- :doc:`Advanced collaboration with connected workspaces across Mattermost instances </onboard/connected-workspaces>`.
 - :doc:`High availability support with multi-node database deployment </scale/high-availability-cluster-based-deployment>`.
 - :doc:`Horizontal scaling through cluster-based deployment </scale/scaling-for-enterprise>`.
 - :doc:`Advanced performance monitoring </scale/deploy-prometheus-grafana-for-performance-monitoring>`.

diff --git a/source/about/subscription.rst b/source/about/subscription.rst
@@ -126,7 +126,7 @@ How is a user defined for subscriptions?
 
 For the purpose of billing, a “user” is any account created in Mattermost that does not show as **Deactivated** in **System Console > User Management > Users**. Guests are also defined as users.
 
-Bots, deactivated users, and synthetic users in :doc:`Microsoft Teams integrations </collaborate/collaborate-within-connected-microsoft-teams>` and :doc:`shared channels users </onboard/shared-channels>`, aren't counted towards the total number of activated users.
+Bots, deactivated users, and synthetic users in :doc:`Microsoft Teams integrations </collaborate/collaborate-within-connected-microsoft-teams>` and :doc:`connected workspace </onboard/connected-workspaces>` users aren't counted towards the total number of activated users.
 
 You can review your user count, for billing purposes, by going to **System Console > Site Statistics**, under **Total Activated Users**.
 

diff --git a/source/conf.py b/source/conf.py
@@ -1508,7 +1508,7 @@ def setup(_: Sphinx):
 "configure/configuration-settings.html#user-status-away-timeout":
         "https://docs.mattermost.com/configure/experimental-configuration-settings.html#user-status-away-timeout",
 "configure/configuration-settings.html#enable-shared-channels":
-        "https://docs.mattermost.com/configure/experimental-configuration-settings.html#enable-shared-channels",
+        "https://docs.mattermost.com/configure/site-configuration-settings.html#enable-connected-workspaces",
 "configure/configuration-settings.html#enable-bleve-indexing":
         "https://docs.mattermost.com/configure/experimental-configuration-settings.html#enable-bleve-indexing",
 "configure/configuration-settings.html#index-directory":
@@ -1887,6 +1887,9 @@ def setup(_: Sphinx):
         "https://docs.mattermost.com/configure/environment-configuration-settings.html#elasticsearch",
 "configure/database-configuration-settings":
         "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",
+
 
 # Deploy redirects
 "deploy/mobile-apps-faq.html":
@@ -3237,6 +3240,18 @@ def setup(_: Sphinx):
         "https://docs.mattermost.com/onboard/sso-saml.html",
 "onboard/common-sso-entraid.html":
         "https://docs.mattermost.com/onboard/sso-entraid.html",
+"onboard/shared-channels.html":
+        "https://docs.mattermost.com/onboard/connected-workspaces.html",
+"onboard/shared-channels.html#set-up-shared-channels":
+        "https://docs.mattermost.com/onboard/connected-workspaces.html#set-up-connected-workspaces",
+"onboard/shared-channels.html#create-a-secure-connection-invitation":
+        "https://docs.mattermost.com/onboard/connected-workspaces.html#create-a-secure-connection",
+"onboard/shared-channels.html#accept-a-secure-connection-invitation":
+        "https://docs.mattermost.com/onboard/connected-workspaces.html#accept-a-connection-invitation",
+"onboard/shared-channels.html#share-channels-with-secure-connections":
+        "https://docs.mattermost.com/onboard/connected-workspaces.html#share-channels-with-secure-connections",
+"onboard/shared-channels.html#frequently-asked-questions":
+        "https://docs.mattermost.com/onboard/connected-workspaces.html#frequently-asked-questions",
 
 # Overview redirects
 "overview/architecture.html":
@@ -4046,6 +4061,8 @@ def setup(_: Sphinx):
 .. |add-user-icon| image:: /images/account-plus-outline_F0801.svg
     :alt: Account plus outline icon used to add user to a channel.
     :class: theme-icon
+.. |shared| image:: /images/circle-multiple-outline_F0695.svg
+    :alt: Shared icon indicates channels and their members that are shared across connected Mattermost servers.
 .. |saved-icon| image:: /images/bookmark_F00C0.svg
     :alt: Saved icon.
     :class: theme-icon

diff --git a/source/configure/deprecated-configuration-settings.rst b/source/configure/deprecated-configuration-settings.rst
@@ -834,4 +834,21 @@ This configuration setting disables the ability to send inactivity email notific
 Disable Apps Bar
 ~~~~~~~~~~~~~~~~
 
-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. This setting is enabled for all customers by default from Mattermost v8.0.
+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``. |
++------------------------------------------------------------------------------------------------------------+
diff --git a/source/configure/experimental-configuration-settings.rst b/source/configure/experimental-configuration-settings.rst
@@ -598,36 +598,6 @@ This setting defines the number of seconds after which the user's status indicat
 | This feature's ``config.json`` setting is ``"UserStatusAwayTimeout": 300`` with numerical input. |
 +--------------------------------------------------------------------------------------------------+
 
-.. config:setting:: exp-enablesharedchannels
-  :displayname: Enable shared channels (Experimental)
-  :systemconsole: Experimental > Features
-  :configjson: ExperimentalSettings:EnableSharedChannels, ExperimentalSettings:EnableRemoteClusterService
-  :environment: N/A
-
-  Shared channels enables 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.
-  Both configuration settings must be enabled in order to share channels with secure connections. Only the **Enable Shared Channels** configuration option is available through the System Console. Default value of both settings is **false**.
-
-Enable shared channels
-~~~~~~~~~~~~~~~~~~~~~~
-
-.. include:: ../_static/badges/ent-selfhosted-only.rst
-  :start-after: :nosearch:
-
-.. raw:: html
-
- <p class="mm-label-note">Also available in legacy Mattermost Enterprise Edition E20</p>
-
-Shared channels enables 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. Enabling shared channels functionality requires a server restart.
-
-+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| This feature's two ``config.json`` settings include ``"ExperimentalSettings:EnableSharedChannels": false`` with options ``true`` or ``false``, and ``"ExperimentalSettings:EnableRemoteClusterService": false`` with options ``true`` or ``false``. |
-+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-.. note::
-
-   - Both configuration settings must be enabled in order to share channels with secure connections. Only the **Enable Shared Channels** configuration option is available through the System Console.
-   - System admins for Cloud deployments can submit a request to have the ``EnableRemoteClusterService`` configuration setting enabled in their Cloud instance.
-
 Disable data refetching on browser refocus
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -648,7 +618,7 @@ This setting disables attempts to detect when the computer has woken up and refe
 
 **True**: Mattermost won't attempt to detect when the computer has woken up and refetch data. This might reduce the amount of regular network traffic the app is sending.
 
-**False**: (Default) Mattermost attempts to detect when the computer has woken up and refreshes data.
+**False**: (**Default**) Mattermost attempts to detect when the computer has woken up and refreshes data.
 
 +--------------------------------------------------------------------------------------------------------------------------------------------------+
 | This feature's ``config.json`` setting is ``"ExperimentalSettings.DisableWakeUpReconnectHandler": false`` with options ``true`` and ``false``.   |
@@ -1148,37 +1118,6 @@ This setting isn't available in the System Console and can only be set in ``conf
 | This feature's ``config.json`` setting is ``"RestrictSystemAdmin": "false"`` with options ``true`` and ``false``. |
 +-------------------------------------------------------------------------------------------------------------------+
 
-.. config:setting:: exp-remoteclusters
-  :displayname: Remote clusters (Experimental)
-  :systemconsole: N/A
-  :configjson: RemoteClusters
-  :environment: N/A
-
-  - **true**: System admins can manage remote clusters using the System Console.
-  - **false**: **(Default)** Remote cluster management is disabled.
-
-Remote clusters
-~~~~~~~~~~~~~~~
-
-.. include:: ../_static/badges/ent-only.rst
-  :start-after: :nosearch:
-
-.. raw:: html
-
- <p class="mm-label-note">Also available in legacy Mattermost Enterprise Edition E20</p>
-
-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**: Remote cluster management is disabled.
-
-+------------------------------------------------------------------------------------------------------------+
-| This feature's ``config.json`` setting is ``"RemoteClusters": false`` with options ``true`` and ``false``. |
-+------------------------------------------------------------------------------------------------------------+
-
 .. config:setting:: exp-enableclientcert
   :displayname: Enable client-side certification (Experimental)
   :systemconsole: N/A

diff --git a/source/configure/reporting-configuration-settings.rst b/source/configure/reporting-configuration-settings.rst
@@ -19,21 +19,21 @@ Site statistics
 
  <p class="mm-label-note">Also available in legacy Mattermost Enterprise Edition E10 or E20</p>
 
-+----------------------------------------------------------------+-------------------------------------------------------------+
-| View statistics on a wide variety of activities in Mattermost, | - System Config path: **Reporting > Site Statistics**       |
-| including: users, seats, teams, channels, posts, calls,        | - ``config.json setting``: N/A                              |
-| sessions, commands, webhooks, websocket and database           | - Environment variable: N/A                                 |
-| connections, and collaborative playbooks,                      |                                                             |
-+----------------------------------------------------------------+-------------------------------------------------------------+
-| **Notes**:                                                                                                                   |
-|                                                                                                                              |
-| - Bots, deactivated users, and synthetic users in                                                                            |
-|   :doc:`Microsoft Teams integrations </collaborate/collaborate-within-connected-microsoft-teams>`                            |
-|   and :doc:`shared channels users </onboard/shared-channels>` 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>`.                                                                                 |
-+---------------------------------------------------------------+--------------------------------------------------------------+
++----------------------------------------------------------------+---------------------------------------------------------------------+
+| View statistics on a wide variety of activities in Mattermost, | - System Config path: **Reporting > Site Statistics**               |
+| including: users, seats, teams, channels, posts, calls,        | - ``config.json setting``: N/A                                      |
+| sessions, commands, webhooks, websocket and database           | - Environment variable: N/A                                         |
+| connections, and collaborative playbooks,                      |                                                                     |
++----------------------------------------------------------------+---------------------------------------------------------------------+
+| **Notes**:                                                                                                                           |
+|                                                                                                                                      |
+| - 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.   |
+| - 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>`.                                                                                         |
++---------------------------------------------------------------+----------------------------------------------------------------------+
 
 ----
 
@@ -51,7 +51,7 @@ Team statistics
 +---------------------------------------------------------------+---------------------------------------------------------------+
 | **Note**: Bots, deactivated users, and synthetic users in                                                                     |
 | :doc:`Microsoft Teams integrations </collaborate/collaborate-within-connected-microsoft-teams>`                               |
-| and :doc:`shared channels users </onboard/shared-channels>`, aren't counted towards the total number of active users.         |
+| and :doc:`connected workspaces </onboard/connected-workspaces>` users aren't counted towards the total number of active users. |
 +---------------------------------------------------------------+---------------------------------------------------------------+
 
 ----