From f3f518cac5e1baa9c1672a8ec5b77b98c3df4d48 Mon Sep 17 00:00:00 2001 From: Emmanuel Yusufu Kimaswa Date: Fri, 5 Jun 2026 22:57:11 +0300 Subject: [PATCH] docs: fix broken code, command, and link examples Several examples across the admin and deployment guides don't run or render as written: - comply/electronic-discovery: the curl example had the closing single quote after the URL, putting the URL inside the Authorization header value. Moved it to right after the token. - configure/CJK search: missing semicolon after CREATE EXTENSION zhparser. - manage/health-check-probes: the Go import used a github.com/.../tree/master web URL and an unbalanced quote; replaced with the real import path. - onboard/sso-entraid: the Microsoft Entra ID hyperlink was missing its opening backtick, so it didn't render as a link. - scale/enterprise-search: opensearch used triple backticks; reStructuredText inline literals are double backticks (elasticsearch on the same line is). - upgrade/admin-onboarding-tasks: cross-reference display text read 'mmctl user deletall'; the command is deleteall (the ref target spells it). - upgrade/upgrading-postgres: the catalog is pg_statistic, not pg_statistics. - desktop/linux-install: rpm upgrade flag is -U, not -u. - server/linux/deploy-tar: 'rm - rf' had a stray space inside the flag. --- source/administration-guide/comply/electronic-discovery.rst | 2 +- .../configure/enabling-chinese-japanese-korean-search.rst | 2 +- .../manage/configure-health-check-probes.rst | 2 +- source/administration-guide/onboard/sso-entraid.rst | 2 +- source/administration-guide/scale/enterprise-search.rst | 2 +- source/administration-guide/upgrade/admin-onboarding-tasks.rst | 2 +- source/administration-guide/upgrade/upgrading-postgres.rst | 2 +- source/deployment-guide/desktop/linux-desktop-install.rst | 2 +- source/deployment-guide/server/linux/deploy-tar.rst | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/source/administration-guide/comply/electronic-discovery.rst b/source/administration-guide/comply/electronic-discovery.rst index bea43c2bcef..166081be688 100644 --- a/source/administration-guide/comply/electronic-discovery.rst +++ b/source/administration-guide/comply/electronic-discovery.rst @@ -58,7 +58,7 @@ Include the ``token`` value sent in the response as part of the Authorization he .. code-block:: sh - curl -i -H 'Authorization: Bearer yi94pwci6ibjfc9phbikhqutbe http://yourmattermosturl/api/v4/users/me' + curl -i -H 'Authorization: Bearer yi94pwci6ibjfc9phbikhqutbe' http://yourmattermosturl/api/v4/users/me Once you're authenticated into Mattermost, you can use the `Compliance API to create a new compliance report `__. The curl based example below demonstrates how to send a request that bases the authentication token and asks Mattermost to create a report that spans posts from Dec 31, 2017 - 8:15 PM to Dec 31, 2018 - 8:15 PM for a user with the email address craig@mattermost.com: diff --git a/source/administration-guide/configure/enabling-chinese-japanese-korean-search.rst b/source/administration-guide/configure/enabling-chinese-japanese-korean-search.rst index 4fbb66e3ac9..921e66a59e0 100644 --- a/source/administration-guide/configure/enabling-chinese-japanese-korean-search.rst +++ b/source/administration-guide/configure/enabling-chinese-japanese-korean-search.rst @@ -86,7 +86,7 @@ Below is additional information on how to configure the database for different l .. code-block:: sql -- 创建 extension - CREATE EXTENSION zhparser + CREATE EXTENSION zhparser; -- 创建 text search configuration CREATE TEXT SEARCH CONFIGURATION simple_zh_cfg (PARSER = zhparser); -- 配置 token mapping diff --git a/source/administration-guide/manage/configure-health-check-probes.rst b/source/administration-guide/manage/configure-health-check-probes.rst index 1c394b15cd2..83636cfdfc6 100644 --- a/source/administration-guide/manage/configure-health-check-probes.rst +++ b/source/administration-guide/manage/configure-health-check-probes.rst @@ -31,7 +31,7 @@ This endpoint can also be provided to schedulers like `Kubernetes `_ documentation to learn more about getting an Azure AD tenant. +A Microsoft Active Directory (AD) tenant is a dedicated instance of Azure Active Directory (Azure AD) that you own and would have received when signing up for a Microsoft cloud service, such as Azure or Entra ID. Tenants are commonly used by organizations who want to store information about their users, such as passwords, user profile data, and permissions. See the `Microsoft Entra ID `_ documentation to learn more about getting an Azure AD tenant. To allow your Azure AD users to log in to Mattermost using Entra ID SSO, you must register Mattermost in the Microsoft Azure AD tenant that contains the users' information. The registration can be done from the `Microsoft Azure portal `__. The steps to register the Mattermost account in the tenant should be similar to those provided above, and you can find more information about `integrating apps with Azure AD here `_. diff --git a/source/administration-guide/scale/enterprise-search.rst b/source/administration-guide/scale/enterprise-search.rst index a587a01a39f..e060bdf2c72 100644 --- a/source/administration-guide/scale/enterprise-search.rst +++ b/source/administration-guide/scale/enterprise-search.rst @@ -63,7 +63,7 @@ Review the following support paths for enterprise search based on the version yo 1. Disable "compatibility mode" in OpenSearch. 2. Upgrade Mattermost server. - 3. Update the Mattermost ``ElasticsearchSettings.Backend`` configuration setting value from ``elasticsearch`` to ```opensearch``` manually or using :ref:`mmctl `. This value cannot be changed using the System Console. See the Mattermost search :ref:`backend type ` configuration setting documentation for additional details. + 3. Update the Mattermost ``ElasticsearchSettings.Backend`` configuration setting value from ``elasticsearch`` to ``opensearch`` manually or using :ref:`mmctl `. This value cannot be changed using the System Console. See the Mattermost search :ref:`backend type ` configuration setting documentation for additional details. 4. Restart the Mattermost server. Frequently asked questions (FAQ) diff --git a/source/administration-guide/upgrade/admin-onboarding-tasks.rst b/source/administration-guide/upgrade/admin-onboarding-tasks.rst index 47a9bd79c61..74f7adfd9a1 100644 --- a/source/administration-guide/upgrade/admin-onboarding-tasks.rst +++ b/source/administration-guide/upgrade/admin-onboarding-tasks.rst @@ -39,7 +39,7 @@ Important administration notes **DO NOT manipulate the Mattermost database** - In particular, DO NOT manually delete data from the database directly. Mattermost is designed as a continuous archive and cannot be supported after manual manipulation. -- If you need to permanently delete a team or user, use the :ref:`mmctl user delete ` command or the :ref:`mmctl user deletall ` command. +- If you need to permanently delete a team or user, use the :ref:`mmctl user delete ` command or the :ref:`mmctl user deleteall ` command. Common tasks ------------ diff --git a/source/administration-guide/upgrade/upgrading-postgres.rst b/source/administration-guide/upgrade/upgrading-postgres.rst index 7701ae9f0e6..251c23db5dc 100644 --- a/source/administration-guide/upgrade/upgrading-postgres.rst +++ b/source/administration-guide/upgrade/upgrading-postgres.rst @@ -135,7 +135,7 @@ When running PostgreSQL in Docker, ``pg_dump``/``pg_restore`` is the recommended After the upgrade ------------------ -After upgrading PostgreSQL, run ``ANALYZE VERBOSE`` on the Mattermost database. This re-populates the ``pg_statistics`` table used by PostgreSQL to generate optimal query plans. Skipping this step can result in degraded database performance. +After upgrading PostgreSQL, run ``ANALYZE VERBOSE`` on the Mattermost database. This re-populates the ``pg_statistic`` table used by PostgreSQL to generate optimal query plans. Skipping this step can result in degraded database performance. .. code-block:: sh diff --git a/source/deployment-guide/desktop/linux-desktop-install.rst b/source/deployment-guide/desktop/linux-desktop-install.rst index cb9777c94cc..5e9c0b3e572 100644 --- a/source/deployment-guide/desktop/linux-desktop-install.rst +++ b/source/deployment-guide/desktop/linux-desktop-install.rst @@ -71,7 +71,7 @@ This page describes how to install the Mattermost desktop app on Linux. .. code-block:: sh - sudo rpm -u mattermost-desktop-6.2.0-linux-x86_64.rpm + sudo rpm -U mattermost-desktop-6.2.0-linux-x86_64.rpm .. tip:: You can review the current version of your desktop app by selecting the **More** |more-icon-vertical| icon located in the top left corner of the desktop app, then selecting **Help > Version...**. diff --git a/source/deployment-guide/server/linux/deploy-tar.rst b/source/deployment-guide/server/linux/deploy-tar.rst index fa5b6693e16..eb2cfe97e20 100644 --- a/source/deployment-guide/server/linux/deploy-tar.rst +++ b/source/deployment-guide/server/linux/deploy-tar.rst @@ -182,7 +182,7 @@ To remove the Mattermost Server for any reason, you must stop the Mattermost Ser .. code-block:: sh - sudo rm - rf /opt/mattermost + sudo rm -rf /opt/mattermost .. note::