V11.7 Docs

[amyblais]

To be merged on Friday, May 15th.

[coderabbitai]

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

• @coderabbitai resume to resume automatic reviews.
• @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

• ▶️ Resume reviews
• 🔍 Trigger review

📝 Walkthrough

Walkthrough

Documentation and Sphinx metadata updates: bumped commented Sphinx version to '11.7'; replaced v10.5 ESR references with v10.11 and recommended upgrade target v11.7 across product-overview and upgrade docs; adjusted release-policy timeline date; added enterprise-search health-check behaviour, reconnection/backoff, sample logs, and a new Prometheus metric; added analytics-query-timeout DB setting and reformatted query-timeout table.

Changes

Sphinx configuration

Layer / File(s)	Summary
Metadata source/conf.py	Bumped commented Sphinx version and release values from '11.6' → '11.7'.

ESR upgrade guidance & release policy

Layer / File(s)	Summary
Policy text updates source/administration-guide/upgrade/prepare-to-upgrade-mattermost.rst, source/product-overview/common-esr-support-rst.rst, source/product-overview/common-esr-support-upgrade.md, source/product-overview/common-esr-support.md	Replaced references to Mattermost Server v10.5 → v10.11 (EOL date updated) and changed upgrade recommendation/target from v10.11 → v11.7; updated linked release references and wording.
Timeline adjustment source/product-overview/release-policy.md	Adjusted ESR Gantt entry start date (2026-05-16 → 2026-05-15) and updated example upgrade links/wording to reference v10.11 and v11.7 ESRs.

Enterprise search behaviour and metrics

Layer / File(s)	Summary
Behavior docs source/administration-guide/scale/enterprise-search.rst, source/administration-guide/scale/common-configure-mattermost-for-enterprise-search.rst	Documented v11.7 search-engine health-check behaviour: periodic health checks, immediate DB fallback on first failure, engine shutdown after consecutive failures, exponential-backoff reconnection, automatic recovery triggers, and example log messages.
Metrics docs source/administration-guide/scale/performance-monitoring-metrics.rst	Added mattermost_search_engine_status Prometheus metric (binary status) to search metrics list for outage alerting.

Environment configuration settings

Layer / File(s)	Summary
Table reformat / new setting source/administration-guide/configure/environment-configuration-settings.rst	Reformatted query-timeout documentation table; added new analytics-query-timeout setting with System Console path, config.json path (.SqlSettings.AnalyticsQueryTimeout), env var (MM_SQLSETTINGS_ANALYTICSQUERYTIMEOUT), default and description.
Config declaration source/administration-guide/configure/environment-configuration-settings.rst	Introduced .. config:setting:: analytics-query-timeout block with metadata (:displayname:, :systemconsole:, :configjson:, :environment:, :description:).

Sequence Diagram(s)

sequenceDiagram
    autonumber
    participant Mattermost as Mattermost Server
    participant SearchEngine as Elasticsearch/OpenSearch
    participant DB as Database
    participant Prom as Prometheus

    rect rgba(200,200,255,0.5)
    Mattermost->>SearchEngine: periodic health check
    end

    alt health OK
        SearchEngine-->>Mattermost: healthy
        Note right of Mattermost: continue using search engine
    else first failure
        SearchEngine-->>Mattermost: unhealthy
        Mattermost->>DB: route search queries to database (fallback)
        Mattermost->>Prom: expose metric mattermost_search_engine_status = 0
        Note right of Mattermost: start exponential-backoff retries
    end

    opt consecutive failures
        Mattermost->>SearchEngine: disable engine, stop forwarding
        Mattermost->>Prom: metric remains 0
    end

    opt recovery
        SearchEngine-->>Mattermost: responds healthy
        Mattermost->>SearchEngine: resume engine, re-evaluate config/license
        Mattermost->>Prom: metric mattermost_search_engine_status = 1
    end

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

• MM-67505 Add AnalyticsQueryTimeout setting and use when refreshing materialized views #8846: Adds the same AnalyticsQueryTimeout configuration entry and related documentation updates.
• MM-67433, MM-66612, MM-67291: Add new ES/OS changes #8882: Adds/updates enterprise-search outage handling, health checks, reconnection/backoff, and introduces mattermost_search_engine_status metric (overlaps enterprise-search content).
• V11.5 Docs #8745: Updates Sphinx version/release strings in source/conf.py (related metadata bump).

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'V11.7 Docs' is vague and generic, using non-descriptive terms that do not convey meaningful information about the specific changes in the changeset.	Provide a more descriptive title that reflects the main focus, such as 'Update documentation for v11.7 release' or 'Update ESR lifecycle and feature documentation for v11.7'.
Description check	❓ Inconclusive	No pull request description was provided by the author, making it impossible to assess whether it relates to the changeset.	Add a description explaining the purpose and scope of the documentation updates for the v11.7 release.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch v11.7-documentation

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

• Generate code and open pull requests
• Plan features and break down work
• Investigate incidents and troubleshoot customer tickets together
• Automate recurring tasks and respond to alerts with triggers
• Summarize progress and report instantly

Built for teams:

• Shared memory across your entire org—no repeating context
• Per-thread sandboxes to safely plan and execute work
• Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull request overview

Updates the Sphinx documentation configuration to reflect the Mattermost 11.7 documentation version, aligning the docs build metadata with the “V11.7 Docs” release.

Changes:

• Bumps the commented Sphinx version placeholder from 11.6 to 11.7.
• Bumps the commented Sphinx release placeholder from 11.6 to 11.7.

[github-actions]

Newest code from mattermost has been published to preview environment for Git SHA cb3019b

[github-actions]

Newest code from mattermost has been published to preview environment for Git SHA ec06c14

[github-actions]

Newest code from mattermost has been published to preview environment for Git SHA 9e260d9

[github-actions]

Newest code from mattermost has been published to preview environment for Git SHA 9603a85

[github-actions]

Newest code from mattermost has been published to preview environment for Git SHA b19d633

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@source/product-overview/release-policy.md`:
- Line 86: Replace the hardcoded absolute URLs in the sentence referencing the
v10.11 ESR and v11.7 ESR with repo-appropriate relative Markdown links: locate
the two inline links whose link text is "v10.11 ESR" and "v11.7 ESR" and convert
each href from the full https://docs.mattermost.com/... URL to the corresponding
relative path used by the repo (relative Markdown link syntax) so the links
point to the same internal doc pages without the external domain.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2bf7bc80-543f-4b69-8e1a-1ab4a9308fe9

📥 Commits

Reviewing files that changed from the base of the PR and between 9e260d9 and b19d633.

📒 Files selected for processing (5)

• source/administration-guide/upgrade/prepare-to-upgrade-mattermost.rst
• source/product-overview/common-esr-support-rst.rst
• source/product-overview/common-esr-support-upgrade.md
• source/product-overview/common-esr-support.md
• source/product-overview/release-policy.md

✅ Files skipped from review due to trivial changes (4)

• source/product-overview/common-esr-support-rst.rst
• source/administration-guide/upgrade/prepare-to-upgrade-mattermost.rst
• source/product-overview/common-esr-support.md
• source/product-overview/common-esr-support-upgrade.md

[github-actions]

Newest code from mattermost has been published to preview environment for Git SHA 5c9347c

[github-actions]

Newest code from mattermost has been published to preview environment for Git SHA 3459a12

[github-actions]

Newest code from mattermost has been published to preview environment for Git SHA 032c883

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In
`@source/administration-guide/scale/common-configure-mattermost-for-enterprise-search.rst`:
- Line 43: The sentence currently reads as unconditional that "the Mattermost
Server will fall back on Database search"; update it to clarify the conditional
behavior: state that the server will fall back to Database Search only if
Database Search is enabled, and if Database Search has been disabled the server
cannot fall back and search will be unavailable during Elasticsearch/OpenSearch
outages. Update the sentence around the phrase "will fall back on Database
search" and keep the link to the outage handling FAQ (the :ref:`outage handling
FAQ <administration-guide/scale/enterprise-search:how does mattermost handle
elasticsearch or opensearch outages?>`) so readers know where to get details.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 727aeae4-b802-4ee3-8539-e45fb8cf416d

📥 Commits

Reviewing files that changed from the base of the PR and between b19d633 and f019823.

📒 Files selected for processing (3)

• source/administration-guide/scale/common-configure-mattermost-for-enterprise-search.rst
• source/administration-guide/scale/enterprise-search.rst
• source/administration-guide/scale/performance-monitoring-metrics.rst

✅ Files skipped from review due to trivial changes (2)

• source/administration-guide/scale/performance-monitoring-metrics.rst
• source/administration-guide/scale/enterprise-search.rst

[github-actions]

Newest code from mattermost has been published to preview environment for Git SHA f019823

[github-actions]

Newest code from mattermost has been published to preview environment for Git SHA c3d07d4

[github-actions]

Newest code from mattermost has been published to preview environment for Git SHA c609915

[github-actions]

Newest code from mattermost has been published to preview environment for Git SHA fe2ea24

[github-actions]

Newest code from mattermost has been published to preview environment for Git SHA e221c46

[github-actions]

Newest code from mattermost has been published to preview environment for Git SHA 171d37a

[github-actions]

Newest code from mattermost has been published to preview environment for Git SHA 1172f08

[github-actions]

Newest code from mattermost has been published to preview environment for Git SHA a2b0d31

[github-actions]

Newest code from mattermost has been published to preview environment for Git SHA 1aeb2d2

[github-actions]

Newest code from mattermost has been published to preview environment for Git SHA f537b16

[amyblais]

@Combs7th Please help approve this (but not merge yet) before Friday, May 15th.

[github-actions]

Newest code from mattermost has been published to preview environment for Git SHA 0ee5049

[github-actions]

Newest code from mattermost has been published to preview environment for Git SHA bd364c3