Skip to content

Commit

Permalink
Improved consistency using: workspace, instance, & deployment (#7477)
Browse files Browse the repository at this point in the history
  • Loading branch information
cwarnermm authored Oct 11, 2024
1 parent 77fcbd0 commit e0e30c8
Show file tree
Hide file tree
Showing 40 changed files with 55 additions and 51 deletions.
6 changes: 3 additions & 3 deletions source/about/cloud-dedicated.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Mattermost offers advanced security and authentication options for integrating w
Secure networking
~~~~~~~~~~~~~~~~~~

Mattermost Cloud Dedicated supports :doc:`IP filtering </manage/cloud-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 <manage/cloud-ip-filtering:configure ip filtering>` through their Mattermost System Console.
Mattermost Cloud Dedicated supports :doc:`IP filtering </manage/cloud-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 </guides/use-mattermost>` from IPs outside defined ranges are restricted from entry. Cloud system admins can :ref:`configure IP filtering <manage/cloud-ip-filtering:configure ip filtering>` through their Mattermost System Console.

Encryption
~~~~~~~~~~~
Expand All @@ -70,7 +70,7 @@ Connections to calls are secured with a combination of:
Cloud native exports
~~~~~~~~~~~~~~~~~~~~

Mattermost supports optional :ref:`filestore configuration settings <configure/experimental-configuration-settings:enable dedicated export filestore target>` 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 <configure/experimental-configuration-settings:enable dedicated export filestore target>` 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:

Expand Down Expand Up @@ -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 <manage/cloud-data-export:migrate from self-hosted to cloud>` documentation to learn more about migrating from a self-hosted to a Mattermost Cloud instance.
See our :ref:`self-hosted to cloud migration <manage/cloud-data-export:migrate from self-hosted to cloud>` documentation to learn more about migrating from a self-hosted to a Mattermost Cloud instance.
8 changes: 4 additions & 4 deletions source/about/cloud-shared.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <about/editions-and-offerings: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 <about/editions-and-offerings:mattermost enterprise>` on shared infrastructure where resources are shared among multiple Mattermost customers, which might affect performance during peak times.

Reference architecture
----------------------
Expand Down Expand Up @@ -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 <manage/cloud-ip-filtering: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 <manage/cloud-ip-filtering: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 </guides/use-mattermost>` from IPs outside defined ranges are restricted from entry.

Encryption
~~~~~~~~~~~
Expand All @@ -70,7 +70,7 @@ Connections to calls are secured with a combination of:
Cloud native exports
~~~~~~~~~~~~~~~~~~~~

Mattermost supports optional :ref:`filestore configuration settings <configure/experimental-configuration-settings:enable dedicated export filestore target>` 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 <configure/experimental-configuration-settings:enable dedicated export filestore target>` 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:

Expand Down Expand Up @@ -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 <manage/cloud-data-export:migrate from self-hosted to cloud>` documentation to learn more about migrating from a self-hosted to a Mattermost Cloud instance.
See our :ref:`self-hosted to cloud migration <manage/cloud-data-export:migrate from self-hosted to cloud>` documentation to learn more about migrating from a self-hosted to a Mattermost Cloud instance.
2 changes: 1 addition & 1 deletion source/about/cloud-subscriptions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Cloud subscriptions
Cloud Shared </about/cloud-shared>
Cloud VPC Private Connectivity </about/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:

Expand Down
4 changes: 2 additions & 2 deletions source/about/cloud-vpc-private-connectivity.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion source/about/faq-enterprise.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Yes, Enterprises can inquire about `Mattermost Cloud Enterprise <https://matterm

For more information, contact the Mattermost Sales organization at https://mattermost.com/contact-sales/

For small businesses, :ref:`Mattermost Professional <about/editions-and-offerings:mattermost professional>` 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 <about/editions-and-offerings: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?
----------------------------------------------------------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion source/collaborate/access-your-workspace.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 </collaborate/install-desktop-app>`, the :doc:`mobile app for iOS </collaborate/install-ios-app>`, or the :doc:`mobile app for Android </collaborate/install-android-app>`.
Your Mattermost :doc:`workspace </guides/use-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 </collaborate/install-desktop-app>`, the :doc:`mobile app for iOS </collaborate/install-ios-app>`, or the :doc:`mobile app for Android </collaborate/install-android-app>`.

.. tip::

Expand Down
2 changes: 1 addition & 1 deletion source/collaborate/built-in-slash-commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 </guides/use-mattermost>`.

.. tip::

Expand Down
2 changes: 1 addition & 1 deletion source/collaborate/collaborate-within-channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 </collaborate/channel-types>` documentation for details.
Everyone who joins a Mattermost :doc:`workspace </guides/use-mattermost>` is automatically added to two default public channels: **Town Square** and **Off-Topic**. See our :doc:`Channel Types </collaborate/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.
Expand Down
4 changes: 2 additions & 2 deletions source/collaborate/invite-people.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <collaborate/learn-about-roles:team admin>` can also invite people, including :doc:`guests </onboard/guest-accounts>`, 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 <collaborate/learn-about-roles:team admin>` can also invite people, including :doc:`guests </onboard/guest-accounts>`, 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 </guides/use-mattermost>`.
- Adding an existing user to a team or to a channel makes those users team or channel members.

.. tip::
Expand Down
2 changes: 1 addition & 1 deletion source/collaborate/organize-using-custom-user-groups.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 </guides/use-mattermost>`. 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**.

Expand Down
2 changes: 1 addition & 1 deletion source/collaborate/organize-using-teams.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Organize using teams
Team settings </collaborate/team-settings>
Team keyboard shortcuts </collaborate/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 </guides/use-mattermost>` 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 </collaborate/team-settings>` for existing teams.

Expand Down
2 changes: 1 addition & 1 deletion source/collaborate/react-with-emojis-gifs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 </guides/use-mattermost>` 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.
Expand Down
2 changes: 1 addition & 1 deletion source/collaborate/search-for-messages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 </guides/use-mattermost>`, 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::
Expand Down
2 changes: 1 addition & 1 deletion source/collaborate/share-files-in-messages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 </guides/use-mattermost>`. To share an attachment, select the thumbnail of an attachment, then select **Get Public Link**.

.. tip::

Expand Down
2 changes: 1 addition & 1 deletion source/comply/export-mattermost-channel-data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 </guides/use-mattermost>` as a system administrator.
2. Download the latest version of `the plugin binary release <https://github.com/mattermost/mattermost-plugin-channel-export/releases>`__, compatible with Mattermost v8.0.1 and later. If you are using an earlier version of Mattermost, :doc:`follow our documentation </upgrade/upgrading-mattermost-server>` 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**.
Expand Down
2 changes: 1 addition & 1 deletion source/comply/legal-hold.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 </guides/use-mattermost>` as a system administrator.
2. Download the latest version of the `plugin binary release <https://github.com/mattermost/mattermost-plugin-legal-hold/releases/>`_, compatible with Mattermost v8.0.1 and later. If you are using an earlier version of Mattermost, :doc:`follow our documentation </upgrade/upgrading-mattermost-server>` 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**.
Expand Down
Loading

0 comments on commit e0e30c8

Please sign in to comment.