From 81247c1c336e72381eb4338e4fdc6e1682ef858d Mon Sep 17 00:00:00 2001 From: "Carrie Warner (Mattermost)" <74422101+cwarnermm@users.noreply.github.com> Date: Fri, 11 Oct 2024 15:40:45 -0400 Subject: [PATCH] Improved consistency using: workspace, instance, & deployment --- source/about/cloud-dedicated.rst | 6 +++--- source/about/cloud-shared.rst | 8 ++++---- source/about/cloud-subscriptions.rst | 2 +- source/about/cloud-vpc-private-connectivity.rst | 4 ++-- source/about/faq-enterprise.rst | 2 +- source/collaborate/access-your-workspace.rst | 2 +- source/collaborate/built-in-slash-commands.rst | 2 +- source/collaborate/collaborate-within-channels.rst | 2 +- source/collaborate/invite-people.rst | 4 ++-- source/collaborate/organize-using-custom-user-groups.rst | 2 +- source/collaborate/organize-using-teams.rst | 2 +- source/collaborate/react-with-emojis-gifs.rst | 2 +- source/collaborate/search-for-messages.rst | 2 +- source/collaborate/share-files-in-messages.rst | 2 +- source/comply/export-mattermost-channel-data.rst | 2 +- source/comply/legal-hold.rst | 2 +- .../configure/authentication-configuration-settings.rst | 2 +- source/configure/cloud-billing-account-settings.rst | 2 +- source/configure/configuration-settings.rst | 4 ++-- source/configure/experimental-configuration-settings.rst | 2 +- source/configure/manage-user-surveys.rst | 2 +- source/configure/optimize-your-workspace.rst | 2 -- source/configure/reporting-configuration-settings.rst | 3 ++- source/configure/self-hosted-account-settings.rst | 2 +- .../configure/user-management-configuration-settings.rst | 2 +- source/guides/administration.rst | 4 ++-- source/guides/cloud-workspace-management.rst | 2 +- source/guides/self-hosted-administration.rst | 2 +- source/guides/use-mattermost.rst | 7 ++++++- source/integrate/microsoft-calendar-interoperability.rst | 2 +- source/integrate/microsoft-teams-interoperability.rst | 2 +- .../microsoft-teams-meetings-interoperability.rst | 2 +- source/manage/bulk-export-data.rst | 2 +- source/manage/logging.rst | 2 +- source/manage/telemetry.rst | 2 +- source/onboard/guest-accounts.rst | 2 +- source/onboard/shared-channels.rst | 2 +- source/preferences/manage-your-display-options.rst | 2 +- source/recipes/product-vulnerability-incident.rst | 4 ++-- source/scale/collect-performance-metrics.rst | 2 +- 40 files changed, 55 insertions(+), 51 deletions(-) diff --git a/source/about/cloud-dedicated.rst b/source/about/cloud-dedicated.rst index b08205c5bbc..983a4ab726a 100644 --- a/source/about/cloud-dedicated.rst +++ b/source/about/cloud-dedicated.rst @@ -52,7 +52,7 @@ Mattermost offers advanced security and authentication options for integrating w Secure networking ~~~~~~~~~~~~~~~~~~ -Mattermost Cloud Dedicated supports :doc:`IP filtering ` through CIDR-based IP ranges, providing flexibility for system administrators to include various authorized IPs or IP ranges for seamless access control. Users attempting to access the workspace from IPs outside defined ranges are restricted from entry. Cloud system admins can :ref:`configure IP filtering ` through their Mattermost System Console. +Mattermost Cloud Dedicated supports :doc:`IP filtering ` through CIDR-based IP ranges, providing flexibility for system administrators to include various authorized IPs or IP ranges for seamless access control. Users attempting to access their :doc:`workspace ` from IPs outside defined ranges are restricted from entry. Cloud system admins can :ref:`configure IP filtering ` through their Mattermost System Console. Encryption ~~~~~~~~~~~ @@ -70,7 +70,7 @@ Connections to calls are secured with a combination of: Cloud native exports ~~~~~~~~~~~~~~~~~~~~ -Mattermost supports optional :ref:`filestore configuration settings ` to direct compliance and bulk export data to a separate S3 bucket from standard files. This separate bucket can be configured to allow for secure access by Mattermost Cloud teams as well as the workspace admins who manage a given installation. The exports can also be accessed by generating unique download links as needed. +Mattermost supports optional :ref:`filestore configuration settings ` to direct compliance and bulk export data to a separate S3 bucket from standard files. This separate bucket can be configured to allow for secure access by Mattermost Cloud teams as well as admins who manage a given Mattermost deployment. The exports can also be accessed by generating unique download links as needed. The following diagram provides a high-level view of how this functionality works: @@ -98,4 +98,4 @@ Approved plugins developed and/or tested by Mattermost are supported and availab Migrate from a self-hosted instance ------------------------------------ -See our :ref:`workspace migration ` documentation to learn more about migrating from a self-hosted to a Mattermost Cloud instance. \ No newline at end of file +See our :ref:`self-hosted to cloud migration ` documentation to learn more about migrating from a self-hosted to a Mattermost Cloud instance. \ No newline at end of file diff --git a/source/about/cloud-shared.rst b/source/about/cloud-shared.rst index 3d14265583c..8b9891a5fc6 100644 --- a/source/about/cloud-shared.rst +++ b/source/about/cloud-shared.rst @@ -6,7 +6,7 @@ Cloud Shared Mattermost Cloud Shared is designed as a cost-effective solution for companies who don't have strict security and compliance requirements that need a straightforward, managed communication platform without the necessity for extensive customization or dedicated resources. -Your Mattermost workspace is isolated, is fully hosted and managed by Mattermost, and runs :ref:`Mattermost Enterprise ` on shared infrastructure where resources are shared among multiple Mattermost customers, which might affect performance during peak times. +Your Mattermost deployment is isolated, is fully hosted and managed by Mattermost, and runs :ref:`Mattermost Enterprise ` on shared infrastructure where resources are shared among multiple Mattermost customers, which might affect performance during peak times. Reference architecture ---------------------- @@ -52,7 +52,7 @@ Mattermost offers advanced security and authentication options for integrating w Secure networking ~~~~~~~~~~~~~~~~~~ -Enterprise customers with a Mattermost Cloud Shared deployment can :ref:`configure IP filtering ` through CIDR-based IP ranges, within the Mattermost System Console to specify authorized IPs or IP ranges for seamless access control. Users attempting to access the workspace from IPs outside defined ranges are restricted from entry. +Enterprise customers with a Mattermost Cloud Shared deployment can :ref:`configure IP filtering ` through CIDR-based IP ranges, within the Mattermost System Console to specify authorized IPs or IP ranges for seamless access control. Users attempting to access their :doc:`workspace ` from IPs outside defined ranges are restricted from entry. Encryption ~~~~~~~~~~~ @@ -70,7 +70,7 @@ Connections to calls are secured with a combination of: Cloud native exports ~~~~~~~~~~~~~~~~~~~~ -Mattermost supports optional :ref:`filestore configuration settings ` to direct compliance and bulk export data to a separate S3 bucket from standard files. This separate bucket can be configured to allow for secure access by Mattermost Cloud teams as well as the workspace admins who manage a given installation. The exports can also be accessed by generating unique download links as needed. +Mattermost supports optional :ref:`filestore configuration settings ` to direct compliance and bulk export data to a separate S3 bucket from standard files. This separate bucket can be configured to allow for secure access by Mattermost Cloud teams as well as deployment admins who manage a given installation. The exports can also be accessed by generating unique download links as needed. The following diagram provides a high-level view of how this functionality works: @@ -100,4 +100,4 @@ Custom plugins and integrations outside of Mattermost Marketplace aren’t curre Migrate from a self-hosted instance ------------------------------------ -See our :ref:`workspace migration ` documentation to learn more about migrating from a self-hosted to a Mattermost Cloud instance. \ No newline at end of file +See our :ref:`self-hosted to cloud migration ` documentation to learn more about migrating from a self-hosted to a Mattermost Cloud instance. \ No newline at end of file diff --git a/source/about/cloud-subscriptions.rst b/source/about/cloud-subscriptions.rst index d2511c328dd..8e69a12a91c 100644 --- a/source/about/cloud-subscriptions.rst +++ b/source/about/cloud-subscriptions.rst @@ -13,7 +13,7 @@ Cloud subscriptions Cloud Shared Cloud VPC Private Connectivity -Mattermost offers secure, cloud-based collaboration for fast moving enterprises that’s private, scaleable, and low maintenance. Cloud-native architecture supports organizations of any size for a workspace that scales with your team, without any resource planning. +Mattermost offers secure, cloud-based collaboration for fast moving enterprises that’s private, scaleable, and low maintenance. Cloud-native architecture supports organizations of any size for a deployment that scales with your team, without any resource planning. Enterprises can choose between dedicated and shared infrastructure based on your organizations’ size, budget, technical requirements, and level of control and customization needed: diff --git a/source/about/cloud-vpc-private-connectivity.rst b/source/about/cloud-vpc-private-connectivity.rst index ff39e36ad8c..4aab2d7d339 100644 --- a/source/about/cloud-vpc-private-connectivity.rst +++ b/source/about/cloud-vpc-private-connectivity.rst @@ -4,13 +4,13 @@ Cloud VPC Private Connectivity .. include:: ../_static/badges/ent-cloud-only.rst :start-after: :nosearch: -Virtual Private Cloud (VPC) Private Connectivity (Private Link) offers Enterprise Cloud customers tailored solutions for private connectivity needs with Mattermost Cloud. These options enable customers to access Mattermost Cloud through AWS's network without using the public internet, or allow the Mattermost Infrastructure team to manage a Mattermost workspace hosted in the customer's VPC via an EKS cluster. +Virtual Private Cloud (VPC) Private Connectivity (Private Link) offers Enterprise Cloud customers tailored solutions for private connectivity needs with Mattermost Cloud. These options enable customers to access Mattermost Cloud through AWS's network without using the public internet, or allow the Mattermost Infrastructure team to manage a Mattermost instance hosted in the customer's VPC via an EKS cluster. It also provides the ability for customers to connect from Mattermost Cloud to their private webhooks,endpoints and integrations. The key objectives of this offering are to: - Allow customers to access Mattermost Cloud within their internal network. -- Enable the Mattermost Infrastructure team to perform operations on a Mattermost workspace hosted in the customer’s VPC, upon request. +- Enable the Mattermost Infrastructure team to perform operations on a Mattermost instance hosted in the customer’s VPC, upon request. - Establish connectivity between the customer's VPC and Mattermost exclusively through AWS’s network, without exposure to the public internet. - Ensure the setup process is straightforward and easy to implement. - Adhere to all security best practices. diff --git a/source/about/faq-enterprise.rst b/source/about/faq-enterprise.rst index ef78d457409..06132115f40 100644 --- a/source/about/faq-enterprise.rst +++ b/source/about/faq-enterprise.rst @@ -49,7 +49,7 @@ Yes, Enterprises can inquire about `Mattermost Cloud Enterprise ` is available as a self-serve, multi-tenant, software-as-a-service offering, which can be purchased with a credit card at https://customers.mattermost.com/cloud/connect-workspace +For small businesses, :ref:`Mattermost Professional ` is available as a self-serve, multi-tenant, software-as-a-service offering. Do you offer special programs for non-profit organizations, open source projects, or educational institutions? ---------------------------------------------------------------------------------------------------------------- diff --git a/source/collaborate/access-your-workspace.rst b/source/collaborate/access-your-workspace.rst index cde1e7a0228..618ad357151 100644 --- a/source/collaborate/access-your-workspace.rst +++ b/source/collaborate/access-your-workspace.rst @@ -4,7 +4,7 @@ Access your workspace .. include:: ../_static/badges/allplans-cloud-selfhosted.rst :start-after: :nosearch: -Mattermost is accessible through a URL link. You'll receive a link from your Mattermost system admin or through an email invitation. You can use that link in a web browser, or as a server connection in the :doc:`desktop app `, the :doc:`mobile app for iOS `, or the :doc:`mobile app for Android `. +Your Mattermost :doc:`workspace ` is accessible through a URL link. You'll receive a link from your Mattermost system admin or through an email invitation. You can use that link in a web browser, or as a server connection in the :doc:`desktop app `, the :doc:`mobile app for iOS `, or the :doc:`mobile app for Android `. .. tip:: diff --git a/source/collaborate/built-in-slash-commands.rst b/source/collaborate/built-in-slash-commands.rst index 18f2bf3aef7..8a4117f641c 100644 --- a/source/collaborate/built-in-slash-commands.rst +++ b/source/collaborate/built-in-slash-commands.rst @@ -9,7 +9,7 @@ You can interact with Mattermost users, channels, conversations, and more using Slash commands -------------- -The following built-in slash comamnds are available in your Mattermost workspace. +The following built-in slash comamnds are available in your Mattermost :doc:`workspace `. .. tip:: diff --git a/source/collaborate/collaborate-within-channels.rst b/source/collaborate/collaborate-within-channels.rst index 367bcebb680..4d29102d58c 100644 --- a/source/collaborate/collaborate-within-channels.rst +++ b/source/collaborate/collaborate-within-channels.rst @@ -9,7 +9,7 @@ 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 public channels: **Town Square** and **Off-Topic**. See our :doc:`Channel Types ` documentation for details. +Everyone who joins a Mattermost :doc:`workspace ` is automatically added to two default public channels: **Town Square** and **Off-Topic**. See our :doc:`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. diff --git a/source/collaborate/invite-people.rst b/source/collaborate/invite-people.rst index 90677909a62..6eab01c3b3d 100644 --- a/source/collaborate/invite-people.rst +++ b/source/collaborate/invite-people.rst @@ -4,11 +4,11 @@ Add people to your workspace .. include:: ../_static/badges/allplans-cloud-selfhosted.rst :start-after: :nosearch: -Getting people set up with a Mattermost account is typically something that admins do when deploying and configuring the Mattermost workspace. However, :ref:`team admins ` can also invite people, including :doc:`guests `, to a Mattermost team via a `direct invite <#send-a-direct-invite>`__, a `public team invite link <#send-a-team-invite-link>`__. +Getting people set up with a Mattermost account is typically something that system admins do when deploying and configuring the Mattermost instance. However, :ref:`team admins ` can also invite people, including :doc:`guests `, to a Mattermost team via a `direct invite <#send-a-direct-invite>`__, a `public team invite link <#send-a-team-invite-link>`__. All users can add existing Mattermost users to a Mattermost team or channel, unless the system admin has restricted the ability for you to do so. -- Inviting people to a team sends an email prompting recipients to create a Mattermost account on your Mattermost workspace. +- Inviting people to a team sends an email prompting recipients to create a Mattermost account on your Mattermost :doc:`workspace `. - Adding an existing user to a team or to a channel makes those users team or channel members. .. tip:: diff --git a/source/collaborate/organize-using-custom-user-groups.rst b/source/collaborate/organize-using-custom-user-groups.rst index a3c4d3db21b..35145fa04dd 100644 --- a/source/collaborate/organize-using-custom-user-groups.rst +++ b/source/collaborate/organize-using-custom-user-groups.rst @@ -27,7 +27,7 @@ Create a custom group 1. Using Mattermost in a web browser or the desktop app, select |plus| at the top of the channel sidebar, then select **Create New User Group**. -2. Specify a name and mention. The mention is the handle you use to @mention a notification to the group. Group names must be unique across the Mattermost workspace. If a name is in use as a channel name, display name, or another custom group's name, it won't be available. +2. Specify a name and mention. The mention is the handle you use to @mention a notification to the group. Group names must be unique across the Mattermost :doc:`workspace `. If a name is in use as a channel name, display name, or another custom group's name, it won't be available. 3. Search for and select members to add to the custom user group, then select **Create Group**. diff --git a/source/collaborate/organize-using-teams.rst b/source/collaborate/organize-using-teams.rst index 9ac079798cf..4a054f3aaa6 100644 --- a/source/collaborate/organize-using-teams.rst +++ b/source/collaborate/organize-using-teams.rst @@ -12,7 +12,7 @@ Organize using teams Team settings Team keyboard shortcuts -A team is a digital workspace where you and your teammates can collaborate in Mattermost. Depending on how Mattermost is set up in your organization, you can belong to one team or multiple teams. +A team is a digital :doc:`workspace ` where you and your teammates can collaborate in Mattermost. Depending on how Mattermost is set up in your organization, you can belong to one team or multiple teams. Users with the **Create Teams** permission can `create new teams <#create-a-team>`__ and :doc:`manage team settings ` for existing teams. diff --git a/source/collaborate/react-with-emojis-gifs.rst b/source/collaborate/react-with-emojis-gifs.rst index 494aaca4624..ac206c48dcb 100644 --- a/source/collaborate/react-with-emojis-gifs.rst +++ b/source/collaborate/react-with-emojis-gifs.rst @@ -58,7 +58,7 @@ Select the **Skin tone** icon in the top right corner of the emoji picker to spe Upload custom emojis ~~~~~~~~~~~~~~~~~~~~ -Using Mattermost in a web browser or the desktop app, you can upload new emojis that everyone in your Mattermost workspace can access to react to messages. From the emoji picker, select **Custom Emoji**. Small, square pictures work best when selecting an image to upload. The file can be any JPG, GIF, or PNG that's up to 512 KiB in size. +Using Mattermost in a web browser or the desktop app, you can upload new emojis that everyone in your Mattermost :doc:`workspace ` can access to react to messages. From the emoji picker, select **Custom Emoji**. Small, square pictures work best when selecting an image to upload. The file can be any JPG, GIF, or PNG that's up to 512 KiB in size. 1. Enter a name for your custom emoji. This is the name that shows up in the emoji autocomplete. 2. Choose **Select**, then select the image to use for the emoji. diff --git a/source/collaborate/search-for-messages.rst b/source/collaborate/search-for-messages.rst index c00b6781836..5a3a05a2965 100644 --- a/source/collaborate/search-for-messages.rst +++ b/source/collaborate/search-for-messages.rst @@ -35,7 +35,7 @@ Search for message and files File contents that match on file name, or contain matching text content within supported document types, are returned in the Search Results pane. Each search result includes file name, extension, and size details, as well as details about when and where the file was originally shared. - - For Mattermost Cloud workspaces, supported document file formats include PDF, PPTX, DOCX, ODT, HTML, and plain text documents. DOC and RTF file formats, as well as the contents of ZIP files, are not supported. + - For Mattermost Cloud :doc:`workspaces `, supported document file formats include PDF, PPTX, DOCX, ODT, HTML, and plain text documents. DOC and RTF file formats, as well as the contents of ZIP files, are not supported. - For Mattermost self-hosted deployments, supported document file formats include PDF, PPTX, DOCX, ODT, HTML, and plain text documents. .. note:: diff --git a/source/collaborate/share-files-in-messages.rst b/source/collaborate/share-files-in-messages.rst index d56ac5b8bd8..71b03e906a5 100644 --- a/source/collaborate/share-files-in-messages.rst +++ b/source/collaborate/share-files-in-messages.rst @@ -16,7 +16,7 @@ With file attachments, you can share additional information that helps your team **Share public links** - Public links allow you to share message attachments with anyone outside your Mattermost workspace. To share an attachment, select the thumbnail of an attachment, then select **Get Public Link**. + Public links allow you to share message attachments with anyone outside your Mattermost :doc:`workspace `. To share an attachment, select the thumbnail of an attachment, then select **Get Public Link**. .. tip:: diff --git a/source/comply/export-mattermost-channel-data.rst b/source/comply/export-mattermost-channel-data.rst index c702cc4e182..4d96209baf9 100644 --- a/source/comply/export-mattermost-channel-data.rst +++ b/source/comply/export-mattermost-channel-data.rst @@ -15,7 +15,7 @@ Enable For self-hosted deployments, a Mattermost system admin must perform the following steps in Mattermost. -1. Log in to your Mattermost workspace as a system administrator. +1. Log in to your Mattermost :doc:`workspace ` as a system administrator. 2. Download the latest version of `the plugin binary release `__, compatible with Mattermost v8.0.1 and later. If you are using an earlier version of Mattermost, :doc:`follow our documentation ` to upgrade to Mattermost v8.0.1 or later. 3. Go to **System Console > Plugins > Plugin Management > Upload Plugin**, and upload the plugin binary you downloaded in the previous step. 4. Go to **System Console > Plugins > Plugin Management**. In the **Installed Plugins** section, scroll to **Channel Export**, and select **Enable**. diff --git a/source/comply/legal-hold.rst b/source/comply/legal-hold.rst index c34a7b04b72..3cfa464f866 100644 --- a/source/comply/legal-hold.rst +++ b/source/comply/legal-hold.rst @@ -49,7 +49,7 @@ Step 3: Set up the Mattermost Legal Hold plugin Install the plugin ^^^^^^^^^^^^^^^^^^ -1. Log in to your Mattermost workspace as a system administrator. +1. Log in to your Mattermost :doc:`workspace ` as a system administrator. 2. Download the latest version of the `plugin binary release `_, compatible with Mattermost v8.0.1 and later. If you are using an earlier version of Mattermost, :doc:`follow our documentation ` to upgrade to Mattermost v8.0.1 or later. 3. Go to **System Console > Plugins > Plugin Management > Upload Plugin**, and upload the plugin binary you downloaded in the previous step. 4. In the **Installed Plugins** section, scroll to **Legal Hold Plugin**, and select **Enable**. diff --git a/source/configure/authentication-configuration-settings.rst b/source/configure/authentication-configuration-settings.rst index 65f4bb74473..8d4b6ce283d 100644 --- a/source/configure/authentication-configuration-settings.rst +++ b/source/configure/authentication-configuration-settings.rst @@ -2913,7 +2913,7 @@ Enable guest access | | - Environment variable: ``MM_GUESTACCOUNTSSETTINGS_ENABLE`` | +----------------------------------------------------------------+---------------------------------------------------------------------+ | **Note**: 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 workspace. | +| deactivated.This means that guest accounts count as a paid user in your Mattermost :doc:`workspace `. | +--------------------------------------------------------------------------------------------------------------------------------------+ .. config:setting:: guest-whitelistdomains diff --git a/source/configure/cloud-billing-account-settings.rst b/source/configure/cloud-billing-account-settings.rst index 7552530446b..510b24617a0 100644 --- a/source/configure/cloud-billing-account-settings.rst +++ b/source/configure/cloud-billing-account-settings.rst @@ -4,7 +4,7 @@ Cloud workspace subscription, billing, and account settings .. include:: ../_static/badges/allplans-cloud.rst :start-after: :nosearch: -Go to **System Console > Billing and Account** to manage the following aspects of your Cloud workspace: +Go to **System Console > Billing and Account** to manage the following aspects of your Cloud deployment: - Access billing history - Manage the :doc:`product subscription ` and account details for your Mattermost Cloud deployment. diff --git a/source/configure/configuration-settings.rst b/source/configure/configuration-settings.rst index 0b48b37eded..b134bf290e2 100644 --- a/source/configure/configuration-settings.rst +++ b/source/configure/configuration-settings.rst @@ -4,7 +4,7 @@ Configuration settings .. include:: ../_static/badges/allplans-cloud-selfhosted.rst :start-after: :nosearch: -System admins for both self-hosted and Cloud Mattermost workspaces can manage Mattermost configuration using the System Console. For self-hosted deployments, admins can additionally edit the ``config.json`` file. +System admins for both self-hosted and Cloud Mattermost deployments can manage Mattermost configuration using the System Console. For self-hosted deployments, admins can additionally edit the ``config.json`` file. .. note:: @@ -24,7 +24,7 @@ Mattermost configuration settings are organized into the following categories wi - :doc:`Compliance configuration settings ` - :doc:`Experimental configuration settings ` -In self-hosted Mattermost deployments, configuration settings are maintained in the ``config.json`` configuration file, located in the ``mattermost/config`` directory, or :doc:`stored in the database `. System admins managing self-hosted workspaces can also modify the ``config.json`` file directly using a text editor. +In self-hosted Mattermost deployments, configuration settings are maintained in the ``config.json`` configuration file, located in the ``mattermost/config`` directory, or :doc:`stored in the database `. System admins managing self-hosted deployments can also modify the ``config.json`` file directly using a text editor. Configuration in database -------------------------- diff --git a/source/configure/experimental-configuration-settings.rst b/source/configure/experimental-configuration-settings.rst index d21f95b1c9a..3c654965a6a 100644 --- a/source/configure/experimental-configuration-settings.rst +++ b/source/configure/experimental-configuration-settings.rst @@ -691,7 +691,7 @@ This setting enables you to specify an alternate filestore target for Mattermost **False**: Standard :ref:`file storage ` is used (or when the configuration setting is omitted). -When an alternate filestore target is configured, Mattermost Cloud admins can generate an S3 presigned URL for exports using the ``/exportlink [job-id|zip file|latest]`` slash command. See the :ref:`Mattermost workspace migration ` documentation for details. Alternatively, Cloud and self-hosted admins can use the :ref:`mmctl export generate-presigned-url ` command to generate a presigned URL directly from mmctl. +When an alternate filestore target is configured, Mattermost Cloud admins can generate an S3 presigned URL for exports using the ``/exportlink [job-id|zip file|latest]`` slash command. See the :ref:`Mattermost data migration ` documentation for details. Alternatively, Cloud and self-hosted admins can use the :ref:`mmctl export generate-presigned-url ` command to generate a presigned URL directly from mmctl. .. note:: diff --git a/source/configure/manage-user-surveys.rst b/source/configure/manage-user-surveys.rst index 3e30ad2823e..6ae353c4f6a 100644 --- a/source/configure/manage-user-surveys.rst +++ b/source/configure/manage-user-surveys.rst @@ -27,7 +27,7 @@ Install Mattermost offers an additonal :doc:`User Satisfaction Surveys ` option with limited customization options within the **Plugins** list where surveys are enabled by default. We recommend :ref:`disabling the User Satisfaction Surveys functionality ` when using this user survey integration. -1. Log in to your Mattermost workspace as a system administrator. +1. Log in to your Mattermost :doc:`workspace ` as a system administrator. 2. In Mattermost, from the Product menu |product-list|, select **App Marketplace**. 3. Search for or scroll to User Survey, and select **Install**. 4. Once installed, select **Configure**. You're taken to the System Console, directly to the **User Survey** integration page, under **Plugins**. diff --git a/source/configure/optimize-your-workspace.rst b/source/configure/optimize-your-workspace.rst index 3ef7dee1193..414fde58eb8 100644 --- a/source/configure/optimize-your-workspace.rst +++ b/source/configure/optimize-your-workspace.rst @@ -8,8 +8,6 @@ With workspace optimizations, system admins can review their workspace health an System admins can access their workspace optimization page in the System Console by going to **Reporting > Workspace Optimization**. - - .. image:: ../images/workspace-optimization.png :alt: Review your workspace health and growth scores, then take advantage of recommended optimizations. diff --git a/source/configure/reporting-configuration-settings.rst b/source/configure/reporting-configuration-settings.rst index 67d1e46909b..34c3ccdee13 100644 --- a/source/configure/reporting-configuration-settings.rst +++ b/source/configure/reporting-configuration-settings.rst @@ -31,7 +31,8 @@ Site statistics | :doc:`Microsoft Teams integrations ` | | and :doc:`shared channels 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 workspace. | +| deactivated. This means that guest accounts count as a paid user in your Mattermost | +| :doc:`workspace `. | +---------------------------------------------------------------+--------------------------------------------------------------+ ---- diff --git a/source/configure/self-hosted-account-settings.rst b/source/configure/self-hosted-account-settings.rst index d0cf64b8446..17830132411 100644 --- a/source/configure/self-hosted-account-settings.rst +++ b/source/configure/self-hosted-account-settings.rst @@ -4,7 +4,7 @@ Self-hosted workspace edition and license settings .. include:: ../_static/badges/allplans-selfhosted.rst :start-after: :nosearch: -Go to **System Console > About** to manage the following aspects of your self-hosted workspace: +Go to **System Console > About** to manage the following aspects of your self-hosted deployment: - View the :doc:`edition ` of your Mattermost self-hosted deployment. - Manage your :doc:`product subscription `. diff --git a/source/configure/user-management-configuration-settings.rst b/source/configure/user-management-configuration-settings.rst index 4d1a86014df..09b95b43a47 100644 --- a/source/configure/user-management-configuration-settings.rst +++ b/source/configure/user-management-configuration-settings.rst @@ -27,7 +27,7 @@ Mattermost system admins can provision and manage user accounts, team membership Provision users ~~~~~~~~~~~~~~~ -Getting people set up with a Mattermost account is typically something that system admins do when deploying and configuring the Mattermost workspace. A Mattermost admin can :doc:`provision Mattermost users ` using one or more of the following methods: +Getting people set up with a Mattermost account is typically something that system admins do when deploying and configuring the Mattermost deployment. A Mattermost admin can :doc:`provision Mattermost users ` using one or more of the following methods: - :ref:`Enable account creation `. - Use :ref:`mmctl user create ` or Mattermost `APIs `__ to create user accounts. diff --git a/source/guides/administration.rst b/source/guides/administration.rst index eb98c1a5fe5..d83f3da82fb 100644 --- a/source/guides/administration.rst +++ b/source/guides/administration.rst @@ -16,8 +16,8 @@ Manage Mattermost This guide is for people who administer an existing Mattermost server. It’s divided into four parts: -* :doc:`Get started ` - An overview of standard configurations and features for both self-hosted and Cloud workspaces. -* :doc:`Cloud workspace management ` - Detailed information about admin capabilities of Mattermost Cloud workspaces. +* :doc:`Get started ` - An overview of standard configurations and features for both self-hosted and Cloud deployments. +* :doc:`Cloud workspace management ` - Detailed information about admin capabilities of Mattermost Cloud deployments. * :doc:`Self-hosted administration ` - Detailed information about admin capabilities of self-hosted Mattermost servers. * :doc:`Other resources ` - Additional migration, conversion, and troubleshooting resources. diff --git a/source/guides/cloud-workspace-management.rst b/source/guides/cloud-workspace-management.rst index 0f56c02c474..d51777af869 100644 --- a/source/guides/cloud-workspace-management.rst +++ b/source/guides/cloud-workspace-management.rst @@ -5,7 +5,7 @@ This section of the guide is for system admins of Mattermost Cloud deployments. .. tip:: - If you're the admin for a Mattermost self-hosted workspace, see the :doc:`Self-hosted administration ` documentation. + If you're the system admin for a Mattermost self-hosted workspace, see the :doc:`Self-hosted administration ` documentation. .. toctree:: :maxdepth: 1 diff --git a/source/guides/self-hosted-administration.rst b/source/guides/self-hosted-administration.rst index 1b2e0d4ff68..0e42b6752cb 100644 --- a/source/guides/self-hosted-administration.rst +++ b/source/guides/self-hosted-administration.rst @@ -5,7 +5,7 @@ This section of the guide is for system admins of self-hosted Mattermost servers .. tip:: - If you're the admin for a Mattermost Cloud workspace, see the :doc:`Cloud workspace management ` documentation. + If you're the system admin for a Mattermost Cloud workspace, see the :doc:`Cloud workspace management ` documentation. .. toctree:: :maxdepth: 1 diff --git a/source/guides/use-mattermost.rst b/source/guides/use-mattermost.rst index 433f684e613..40b67729dd3 100644 --- a/source/guides/use-mattermost.rst +++ b/source/guides/use-mattermost.rst @@ -4,7 +4,12 @@ Use Mattermost .. include:: ../_static/badges/allplans-cloud-selfhosted.rst :start-after: :nosearch: -This Mattermost end user documentation is designed for anyone looking to connect and collaborate in Mattermost, build repeatable, automated processes, and make Mattermost match your work preferences. +If you're using Mattermost to connect and collaborate, build repeatable, automated processes, and making Mattermost match your work preferences, this Mattermost end user product documentation is for you. + +In this documentation, you'll learn about using Mattermost. + +- Your Mattermost system admin has deployed Mattermost for your organization. A live Mattermost instance is ready for you to log into using your user credentials. +- Your Mattermost workspace is where you'll send and receive messages, see activity notifications, create, run, and participate in playbook runs, and where you'll customize look and feel through workspace preferences. .. toctree:: :maxdepth: 1 diff --git a/source/integrate/microsoft-calendar-interoperability.rst b/source/integrate/microsoft-calendar-interoperability.rst index 6ed8fc01fbd..e0bed9209a8 100644 --- a/source/integrate/microsoft-calendar-interoperability.rst +++ b/source/integrate/microsoft-calendar-interoperability.rst @@ -75,7 +75,7 @@ You're all set for configuration in the Azure portal. Install the Microsoft Calendar integration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -1. Log in to your Mattermost workspace as a system administrator. +1. Log in to your Mattermost :doc:`workspace ` as a system admin. 2. In Mattermost, from the Product menu |product-list|, select **App Marketplace**. 3. Search for or scroll to Microsoft Calendar, and select **Install**. 4. Once installed, select **Configure**. You're taken to the System Console, directly to the **Microsoft Calendar** integration page, under **Plugins**. diff --git a/source/integrate/microsoft-teams-interoperability.rst b/source/integrate/microsoft-teams-interoperability.rst index 0bc221de5c4..2b1347de2e2 100644 --- a/source/integrate/microsoft-teams-interoperability.rst +++ b/source/integrate/microsoft-teams-interoperability.rst @@ -94,7 +94,7 @@ Install and configure the Microsoft Teams integration in Mattermost These installation instructions assume you already have a Mattermost instance running v9.8.0 (or later) and configured to use PostgreSQL. This Mattermost integration doesn't support MySQL databases. -1. Log in to your Mattermost workspace as a system administrator. +1. Log in to your Mattermost :doc:`workspace ` as a system admin. 2. In Mattermost, from the Product menu |product-list|, select **App Marketplace**. 3. Search for or scroll to MS Teams, and select **Install**. 4. Once installed, select **Configure**. You're taken to the System Console. diff --git a/source/integrate/microsoft-teams-meetings-interoperability.rst b/source/integrate/microsoft-teams-meetings-interoperability.rst index bdae4064a79..695599b46e0 100644 --- a/source/integrate/microsoft-teams-meetings-interoperability.rst +++ b/source/integrate/microsoft-teams-meetings-interoperability.rst @@ -65,7 +65,7 @@ You're all set for configuration inside of the Azure portal. Install the Microsoft Teams Meetings integration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -1. Log in to your Mattermost workspace as a system administrator. +1. Log in to your Mattermost :doc:`workspace ` as a system admin. 2. In Mattermost, from the Product menu |product-list|, select **App Marketplace**. 3. Search for or scroll to MS Teams Meetings, and select **Install**. 4. Once installed, select **Configure**. You're taken to the System Console, directly to the **MS Teams Meetings** integration page, under **Plugins**. diff --git a/source/manage/bulk-export-data.rst b/source/manage/bulk-export-data.rst index a3215b77d0f..08ce849bc34 100644 --- a/source/manage/bulk-export-data.rst +++ b/source/manage/bulk-export-data.rst @@ -5,7 +5,7 @@ Bulk export data .. tab:: Use mmctl - 1. Create a full export file including attachments by running the :ref:`mmctl export create -- attachments ` command. See the :ref:`Mattermost workspace migration ` documentation for details. + 1. Create a full export file including attachments by running the :ref:`mmctl export create -- attachments ` command. See the :ref:`Mattermost data migration ` documentation for details. 2. While the job is running, you can check its status by running the :ref:`mmctl export job show ` command. diff --git a/source/manage/logging.rst b/source/manage/logging.rst index 2bba0aa9f63..8b03427a0cc 100644 --- a/source/manage/logging.rst +++ b/source/manage/logging.rst @@ -114,7 +114,7 @@ Audit logging (Beta) .. include:: ../_static/badges/ent-only.rst :start-after: :nosearch: -By default, Mattermost doesn’t write audit logs locally to a file on the server. You can enable and customize experimental audit logging in Mattermost to record activities and events performed within a Mattermost workspace, such as access to the Mattermost REST API or mmctl. +By default, Mattermost doesn’t write audit logs locally to a file on the server. You can enable and customize experimental audit logging in Mattermost to record activities and events performed within a Mattermost :doc:`workspace `, such as access to the Mattermost REST API or mmctl. .. tip:: From Mattermost v9.3, you can enable and customize advanced logging for AD/LDAP events separately from other logging. diff --git a/source/manage/telemetry.rst b/source/manage/telemetry.rst index 64606a7e456..39d78d0b0f8 100644 --- a/source/manage/telemetry.rst +++ b/source/manage/telemetry.rst @@ -18,7 +18,7 @@ We use the data for the following purposes to: .. note:: - Telemetry data collection is enabled by default for all Mattermost deployments. Self-hosted system admins can opt out of sharing telemetry data from Mattermost self-hosted servers within the System Console. Cloud system admins can't disable telemetry for Mattermost Cloud workspaces. + Telemetry data collection is enabled by default for all Mattermost deployments. Self-hosted system admins can opt out of sharing telemetry data from Mattermost self-hosted servers within the System Console. Cloud system admins can't disable telemetry for Mattermost Cloud deployments. Security update check feature ----------------------------- diff --git a/source/onboard/guest-accounts.rst b/source/onboard/guest-accounts.rst index a9b08b110eb..011390d0595 100644 --- a/source/onboard/guest-accounts.rst +++ b/source/onboard/guest-accounts.rst @@ -17,7 +17,7 @@ Guest accounts are a way to collaborate with individuals, such as vendors and co .. important:: - 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 workspace. However, guests aren't automatically added to the default **Town-square** and **Off-topic** channels when they log in. Guests must be invited/added to these channels manually. + 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 `. However, guests aren't automatically added to the default **Town-square** and **Off-topic** channels when they log in. Guests must be invited/added to these channels manually. Enable guest accounts ---------------------- diff --git a/source/onboard/shared-channels.rst b/source/onboard/shared-channels.rst index 1d42763a537..b179a5b4046 100644 --- a/source/onboard/shared-channels.rst +++ b/source/onboard/shared-channels.rst @@ -46,7 +46,7 @@ Extend the invitation ~~~~~~~~~~~~~~~~~~~~~~ 1. Copy the invitation code blob in the System message, then send the code blob and the decryption password to the remote Mattermost aystem admin you want to securely connect with. -2. Ensure that the remote Mattermost instance can access your workspace URL listed in the System message. +2. Ensure that the remote Mattermost instance can access your :doc:`workspace ` URL listed in the System message. Remove a secure connection ~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/preferences/manage-your-display-options.rst b/source/preferences/manage-your-display-options.rst index 93a0381683b..316ead05be6 100644 --- a/source/preferences/manage-your-display-options.rst +++ b/source/preferences/manage-your-display-options.rst @@ -33,7 +33,7 @@ Threaded discussions Threaded discussions offers an enhanced experience for users communicating in threads and replying to messages. Threaded discussions are generally available in Mattermost Cloud and from self-hosted Mattermost v7.0, and are enabled by default for all new Mattermost deployments. -Depending on how your system admin has :ref:`configured threaded discussions ` for your workspace, it may already be enabled for you, or you may be able to enable this feature for your account. See our :doc:`organize conversations using threaded discussions ` documentation to learn more about working with threaded discussions. +Depending on how your system admin has :ref:`configured threaded discussions ` for your :doc:`workspace `, it may already be enabled for you, or you may be able to enable this feature for your account. See our :doc:`organize conversations using threaded discussions ` documentation to learn more about working with threaded discussions. .. tab:: Web/Desktop diff --git a/source/recipes/product-vulnerability-incident.rst b/source/recipes/product-vulnerability-incident.rst index 179dfc1bc8e..85d023f3f80 100644 --- a/source/recipes/product-vulnerability-incident.rst +++ b/source/recipes/product-vulnerability-incident.rst @@ -23,9 +23,9 @@ For Cloud customers, all the functionalities works out-of-the-box with no techni 2. Playbooks setup ~~~~~~~~~~~~~~~~~~ -Now that your workspace and teammates are ready, the next step is to create a playbook for incident handling. For this recipe, we're using an adapted playbooks template used by the Mattermost Product Security team that's available for `download here `__. +Now that your :doc:`workspace ` and teammates are ready, the next step is to create a playbook for incident handling. For this recipe, we're using an adapted playbooks template used by the Mattermost Product Security team that's available for `download here `__. -After downloading the template above, connect to your Mattermost workspace. Then open the product menu and select **Playbooks**. +After downloading the template above, connect to your Mattermost :doc:`workspace `. Then open the product menu and select **Playbooks**. .. image:: ../images/recipe/prod-vuln-incident1.png :alt: From the product menu, select Playbooks. diff --git a/source/scale/collect-performance-metrics.rst b/source/scale/collect-performance-metrics.rst index 5daf33acd60..dcbbd96d3a9 100644 --- a/source/scale/collect-performance-metrics.rst +++ b/source/scale/collect-performance-metrics.rst @@ -21,7 +21,7 @@ Mattermost configuration For a self-hosted Mattermost deployment, a Mattermost system admin must perform the following steps in Mattermost. -1. Log in to your Mattermost workspace as a system administrator. +1. Log in to your Mattermost :doc:`workspace ` as a system admin. 2. Download the latest version of `the plugin binary release `__, compatible with Mattermost v8.0.1 and later. If you are using an earlier version of Mattermost, :doc:`follow our documentation ` to upgrade to Mattermost v8.0.1 or later. 3. Go to **System Console > Plugins > Plugin Management > Upload Plugin**, and upload the plugin binary you downloaded in the previous step. 4. Go to **System Console > Plugins > Plugin Management**. In the **Installed Plugins** section, scroll to **Mattermost Metrics Plugin**, and select **Enable Plugin**.