Skip to content

Commit

Permalink
Merge branch 'master' into amyblais-patch-20
Browse files Browse the repository at this point in the history
  • Loading branch information
amyblais authored Dec 16, 2024
2 parents bd5ecdb + b790d86 commit 521476b
Show file tree
Hide file tree
Showing 95 changed files with 1,254 additions and 386 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ If you have any questions, create an account on the [Mattermost Community server
* [Use GitHub PR Labels](#use-github-pr-labels)
* [Comment on Pull Requests](#comment-on-pull-requests)
* [Review Pull Requests](#review-pull-requests)
* [Build Mattermost product documentation locally](#build-locally)
* [Build locally](#build-locally)

## Contribute to Mattermost product documentation

Expand Down Expand Up @@ -57,9 +57,12 @@ Once the review process is complete, and depending on the type of issue it is (e

## Build locally

If you've downloaded the `mattermost/docs` repository and are editing Mattermost documentation on your local machine, you can generate the HTML files from markdown in the `source` directory. You can review your changes before you commit them or create pull requests.
If you've downloaded the `mattermost/docs` repository to edit Mattermost documentation on your local machine, you can generate the HTML files from the `source` directory. You can review your changes as a live or static preview before committing them or creating new pull requests.

**Note:** Terminal commands can be executed on Linux, Mac, and Windows (using PowerShell).
> [!NOTE]
> You can generate the docs on Linux, Mac, and Windows (using PowerShell); however, builds on Windows are considerably slower because only a single processing core is used.
>
> For faster local docs builds on Windows, we strongly recommend [installing WSL](https://learn.microsoft.com/en-us/windows/wsl/install) to create an Ubuntu virtual machine (VM), where you'll configure the following prerequisites. An Ubuntu VM will use all available processing cores, resulting in faster local builds.
### Build prerequisites

Expand All @@ -71,7 +74,7 @@ The following software is required to build the documentation:

### Build instructions

1. Open a terminal window, then clone a forked copy of the documentation repository:
1. Open a native or VM terminal window, then clone a forked copy of the documentation repository:
```shell
git clone https://github.com/mattermost/docs.git
```
Expand All @@ -83,7 +86,7 @@ The following software is required to build the documentation:

3. Install [pipenv](https://docs.pipenv.org/) by using one of the following commands based on your operating system:

For Mac users where Homebrew is installed:
For Mac users and Ubuntu VM users where Homebrew is installed:
```shell
brew install pipenv
```
Expand All @@ -105,7 +108,7 @@ The following software is required to build the documentation:
- Use `make livehtml` to review a live preview published to `http://127.0.0.1:8000` that automatically updates as new changes are saved in your local IDE.
> [!NOTE]
> Windows users require `make` installed for the build commands above to work correctly. To install `make` via Chocolatey:
> Windows users who aren't building the docs in an Ubuntu VM also require `make` installed for the build commands above to work correctly. To install `make` via Chocolatey:
>
> 1. Install [chocolatey](https://chocolatey.org/).
> 2. In a Windows terminal, select the downward chevron, and hold `CTRL` while selecting **PowerShell** to run commands as an admin.
Expand Down
2 changes: 1 addition & 1 deletion source/_static/badges/selfhosted-only.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Note

![deployment-img-yellow](_static/images/badges/deployment_icon_yellow.svg) Available only for `self-hosted <https://mattermost.com/download/>`_ deployments
![deployment-img-yellow](/_static/images/badges/deployment_icon_yellow.svg) Available only for `self-hosted <https://mattermost.com/download/>`_ deployments

```{raw} html
</div>
Expand Down
2 changes: 1 addition & 1 deletion source/about/certifications-and-compliance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ We are in the process of acquiring Authority to Operate (ATO) and Certificate of
How do you ensure personal data stays within European Union?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

When the customer’s installation of Mattermost is self-hosted, Mattermost does not process any personal data under the jurisdiction of the data privacy laws governing within the European Union. The Mattermost support team leverages Zendesk customer service software, which hosts Mattermost information within the United States. For more information on Zendesk, please see their `Privacy and Data Protection <https://www.zendesk.com/company/privacy-and-data-protection/#gdpr-sub>`_ page.
When the customer’s installation of Mattermost is self-hosted, Mattermost does not process any personal data under the jurisdiction of the data privacy laws governing within the European Union. The Mattermost support team leverages Zendesk customer service software, which hosts Mattermost information within the United States. For more information on Zendesk, please see their `Privacy and Data Protection <https://www.zendesk.com/trust-center/>`_ page.

Zendesk privacy and data protection safeguards notwithstanding, the provision of support services is part of the contractual obligations between Mattermost and its customers. In order for Mattermost to provide such support, a customer must be able to identify as a licensed user, therefore requiring the user to provide personal data to the support agent. Regardless of where the support agent is located, the personal data will indeed be hosted outside of the EU.

Expand Down
13 changes: 9 additions & 4 deletions source/about/deprecated-features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,24 @@ This page describes features that are removed from support for Mattermost, or wi
Removed features in upcoming versions
-------------------------------------

Mattermost Mobile App v2.25.0
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- In the Mattermost Mobile App v2.25, Mattermost will stop supporting iOS versions 13 and 14. Users should update their iOS version to v15.1 or newer before February 14, 2025. See more details in `this forum post <https://forum.mattermost.com/t/deprecation-notice-ios-13-and-14-versions/21845>`__.

Mattermost Server v10.5.0
~~~~~~~~~~~~~~~~~~~~~~~~~

- The Mattermost server will stop supporting manual plugin deployment. Plugins are deployed manually when an administrator or some deployment automation copies the contents of a plugin bundle into the server's working directory. If a manual or automated deployment workflow is still required, administrators can instead prepackage the plugin bundles. See more details in `this forum post <https://forum.mattermost.com/t/deprecation-notice-manual-plugin-deployment/21192>`__.
- Mattermost will stop providing official Mattermost server builds for the Microsoft Windows operating system. Administrators should migrate existing Mattermost server installations to use the official Linux builds. See more details in `this forum post <https://forum.mattermost.com/t/deprecation-notice-server-builds-for-microsoft-windows/21498>`__.

Removed features by Mattermost version
----------------------------------------

Mattermost Server v10.3.0
~~~~~~~~~~~~~~~~~~~~~~~~~

- As part of our continuous efforts to enhance your user experience, we will be phasing out the Classic Mobile App. Please download the new v2 Mobile App from the `Apple App Store <https://apps.apple.com/us/app/mattermost/id1257222717>`_ or `Google Play Store <https://play.google.com/store/apps/details?id=com.mattermost.rn>`_ to continue enjoying our services without interruption. See more details in the `classic mobile app deprecation <https://forum.mattermost.com/t/classic-mobile-app-deprecation/18703>`_ Mattermost forum post.

Removed features by Mattermost version
----------------------------------------
- The Classic Mobile App has been phased out. Please download the new v2 Mobile App from the `Apple App Store <https://apps.apple.com/us/app/mattermost/id1257222717>`_ or `Google Play Store <https://play.google.com/store/apps/details?id=com.mattermost.rn>`_. See more details in the `classic mobile app deprecation <https://forum.mattermost.com/t/classic-mobile-app-deprecation/18703>`_ Mattermost forum post.

Mattermost Server v10.2.0
~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
4 changes: 2 additions & 2 deletions source/about/faq-high-trust.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Vendors become "Nation State Targets" when the value of the breaching their syst

**2) MMTA systems can't protect customers from unknown vulnerabilities**

A single bug in an MMTA system can put all customers at risk. For example, `Slack reported a bug that exposed message histories and files for nearly four million users <https://www.wired.com/2017/03/hack-brief-slack-bug-everyones-worst-office-nightmare/>`__ (2017), and `a bug left 400 million Microsoft accounts exposed to account takeover <https://www.hackread.com/critical-bug-in-microsoft-left-400m-accounts-exposed/>`__ (2018).
A single bug in an MMTA system can put all customers at risk. For example, `Slack reported a bug that exposed message histories and files for nearly four million users <https://www.wired.com/2017/03/hack-brief-slack-bug-everyones-worst-office-nightmare/>`_ (2017), and `a bug left 400 million Microsoft accounts exposed to account takeover <https://hackread.com/critical-bug-in-microsoft-left-400m-accounts-exposed/>`_ (2018).

For multi-tenant systems, bugs in infrastructure can present vulnerabilities as well. For example, in 2018 researchers discovered that chip-level exploits like `Meltdown and Spectre <https://www.wired.com/story/intel-meltdown-spectre-storm/>`__, which had been around for decades, could make it possible for malicious code run by one tenant to affect the operations of another tenant that shared the same CPU.

Expand All @@ -55,7 +55,7 @@ When an MMTA is breached, it is most likely from an unknown bug or an unknown vu

The end result is confidential information passing through an MMTA may be used to exploit other systems the customer operates, with no way to trace the root of the breach to mitigate it in future.

As an example, when `OneLogin reported a security breach that allowed the attacker to decrypt encrypted data impacting 2000 customers and 70 SaaS apps <https://krebsonsecurity.com/2017/06/onelogin-breach-exposed-ability-to-decrypt-data/>`__ (2017), details were vague and there was little customers could do to analyze their risk or reduce risk in future.
As an example, when `OneLogin reported a security breach that allowed the attacker to decrypt encrypted data impacting 2000 customers and 70 SaaS apps <https://krebsonsecurity.com/2017/06/onelogin-breach-exposed-ability-to-decrypt-data/>`_ (2017), details were vague and there was little customers could do to analyze their risk or reduce risk in future.

In contrast, an open source, self-hosted collaboration solution remains within the layers of physical security and network security enterprises use to protect their most valuable assets, with full access to logging and system histories to know when, where and how an attack might have occurred.

Expand Down
1 change: 1 addition & 0 deletions source/about/mattermost-mobile-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ See the [Mobile app changelog](/about/mobile-app-changelog) for release details,

| **Release** | **Released on** | **Support ends** | **Compatible with** |
|:---|:---|:---|:---|
| v2.23 {ref}`FEATURE <release-v2-23-0>` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.23.0) \| {ref}`Changelog <release-v2-23-0>` | 2024-12-16 | 2025-01-15 | {ref}`v10.3 <release-v10.3-feature-release>`, {ref}`v10.2 <release-v10.2-feature-release>`, {ref}`v10.1 <release-v10.1-feature-release>`, {ref}`v9.11 <release-v9-11-extended-support-release>` |
| v2.22 {ref}`FEATURE <release-v2-22-0>` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.22.0) \| {ref}`Changelog <release-v2-22-0>` | 2024-11-15 | 2024-12-15 | {ref}`v10.2 <release-v10.2-feature-release>`, {ref}`v10.1 <release-v10.1-feature-release>`, {ref}`v10.0 <release-v10.0-major-release>`, {ref}`v9.11 <release-v9-11-extended-support-release>`, {ref}`v9.5 <release-v9-5-extended-support-release>` |
| v2.21 {ref}`FEATURE <release-v2-21-0>` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.21.0) \| {ref}`Changelog <release-v2-21-0>` | 2024-10-16 | 2024-11-15 | {ref}`v10.1 <release-v10.1-feature-release>`, {ref}`v10.0 <release-v10.0-major-release>`, {ref}`v9.11 <release-v9-11-extended-support-release>`, {ref}`v9.10 <release-v9-10-feature-release>`, {ref}`v9.5 <release-v9-5-extended-support-release>` |
| v2.20 {ref}`FEATURE <release-v2-20-1>` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.20.1) \| {ref}`Changelog <release-v2-20-1>` | 2024-09-16 | 2024-10-15 | {ref}`v10.0 <release-v10.0-major-release>`, {ref}`v9.11 <release-v9-11-extended-support-release>`, {ref}`v9.10 <release-v9-10-feature-release>`, {ref}`v9.9 <release-v9-9-feature-release>`, {ref}`v9.5 <release-v9-5-extended-support-release>` |
Expand Down
1 change: 1 addition & 0 deletions source/about/mattermost-server-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Mattermost releases a new server version on the 16th of each month in [binary fo

| **Release** | **Released on** | **Support ends** |
|:---|:---|:---|
| v10.3 [Download](https://releases.mattermost.com/10.3.1/mattermost-10.3.1-linux-amd64.tar.gz) \| {ref}`Changelog <release-v10.3-feature-release>` | 2024-12-16 | 2025-03-15 |
| v10.2 [Download](https://releases.mattermost.com/10.2.1/mattermost-10.2.1-linux-amd64.tar.gz) \| {ref}`Changelog <release-v10.2-feature-release>` | 2024-11-15 | 2025-02-15 |
| v10.1 [Download](https://releases.mattermost.com/10.1.4/mattermost-10.1.4-linux-amd64.tar.gz) \| {ref}`Changelog <release-v10.1-feature-release>` | 2024-10-16 | 2025-01-15 |
| v10.0 [Download](https://releases.mattermost.com/10.0.4/mattermost-10.0.4-linux-amd64.tar.gz) \| {ref}`Changelog <release-v10.0-major-release>` | 2024-09-16 | 2024-12-15 |
Expand Down
Loading

0 comments on commit 521476b

Please sign in to comment.