Conversation
|
Note Reviews pausedIt 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 Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughDocumentation 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 ChangesSphinx configuration
ESR upgrade guidance & release policy
Enterprise search behaviour and metrics
Environment configuration settings
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
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (2 inconclusive)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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
versionplaceholder from11.6to11.7. - Bumps the commented Sphinx
releaseplaceholder from11.6to11.7.
|
Newest code from mattermost has been published to preview environment for Git SHA cb3019b |
|
Newest code from mattermost has been published to preview environment for Git SHA ec06c14 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
|
Newest code from mattermost has been published to preview environment for Git SHA 9e260d9 |
|
Newest code from mattermost has been published to preview environment for Git SHA 9603a85 |
* Update ESR docs to reflect v10.11 end-of-life on August 15, 2026 Update placeholder ESR notices across docs to indicate that Mattermost Server v10.11 ESR is coming to end of life on August 15, 2026, and that upgrading to v11.7 or later is recommended. Also update upgrade path examples to include v11.7 ESR. Co-authored-by: Amy Blais <amyblais@users.noreply.github.com> * Update common-esr-support-upgrade.md * Update release-policy.md --------- Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Amy Blais <amyblais@users.noreply.github.com>
|
Newest code from mattermost has been published to preview environment for Git SHA b19d633 |
There was a problem hiding this comment.
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
📒 Files selected for processing (5)
source/administration-guide/upgrade/prepare-to-upgrade-mattermost.rstsource/product-overview/common-esr-support-rst.rstsource/product-overview/common-esr-support-upgrade.mdsource/product-overview/common-esr-support.mdsource/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
|
Newest code from mattermost has been published to preview environment for Git SHA 5c9347c |
|
Newest code from mattermost has been published to preview environment for Git SHA 3459a12 |
* Add new ES/OS behaviour on outages * Document new fast-fail behaviour and health metric
|
Newest code from mattermost has been published to preview environment for Git SHA 032c883 |
There was a problem hiding this comment.
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
📒 Files selected for processing (3)
source/administration-guide/scale/common-configure-mattermost-for-enterprise-search.rstsource/administration-guide/scale/enterprise-search.rstsource/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
|
Newest code from mattermost has been published to preview environment for Git SHA f019823 |
…terialized views (#8846)
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
source/administration-guide/configure/environment-configuration-settings.rst (1)
855-857: Keep table metadata row order consistent with nearby settings.This table lists
config.jsonbeforeSystem Config path, which differs from the surrounding pattern. Reordering improves scanability and consistency.Minimal suggested diff
-| The number of seconds to wait for a response from the database after opening a connection | - ``config.json`` setting: ``SqlSettings`` > ``AnalyticsQueryTimeout`` > ``300`` | -| and sending certain analytics queries. This setting only applies to long queries which are | - System Config path: **Environment > Database** | +| The number of seconds to wait for a response from the database after opening a connection | - System Config path: **Environment > Database** | +| and sending certain analytics queries. This setting only applies to long queries which are | - ``config.json`` setting: ``SqlSettings`` > ``AnalyticsQueryTimeout`` > ``300`` |As per coding guidelines, “Match nearby pages and local repo patterns before applying generic Markdown or English style rules.”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@source/administration-guide/configure/environment-configuration-settings.rst` around lines 855 - 857, The table row ordering is inconsistent with nearby rows; move the "System Config path: **Environment > Database**" entry before the "``config.json`` setting: ``SqlSettings`` > ``AnalyticsQueryTimeout`` > ``300``" entry so the row lists System Config path first, then config.json, then Environment variable (``MM_SQLSETTINGS_ANALYTICSQUERYTIMEOUT``), ensuring the setting names (SqlSettings and AnalyticsQueryTimeout) remain unchanged and the three columns stay aligned with surrounding rows.
🤖 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/configure/environment-configuration-settings.rst`:
- Around line 845-852: Update the :displayname: metadata to match the section
heading's sentence case; change the existing ":displayname: Analytics Query
timeout" to ":displayname: Analytics query timeout" so the display name and the
heading ("Analytics query timeout") are consistent (verify the :description: and
heading text remain unchanged and use sentence case throughout).
---
Nitpick comments:
In
`@source/administration-guide/configure/environment-configuration-settings.rst`:
- Around line 855-857: The table row ordering is inconsistent with nearby rows;
move the "System Config path: **Environment > Database**" entry before the
"``config.json`` setting: ``SqlSettings`` > ``AnalyticsQueryTimeout`` > ``300``"
entry so the row lists System Config path first, then config.json, then
Environment variable (``MM_SQLSETTINGS_ANALYTICSQUERYTIMEOUT``), ensuring the
setting names (SqlSettings and AnalyticsQueryTimeout) remain unchanged and the
three columns stay aligned with surrounding rows.
🪄 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: d0b8eb79-1e65-464d-82a4-256b08f0eec3
📒 Files selected for processing (1)
source/administration-guide/configure/environment-configuration-settings.rst
|
Newest code from mattermost has been published to preview environment for Git SHA 07ca0bd |
|
Newest code from mattermost has been published to preview environment for Git SHA 27db3a8 |
|
Newest code from mattermost has been published to preview environment for Git SHA c3d07d4 |
|
Newest code from mattermost has been published to preview environment for Git SHA c609915 |
|
Newest code from mattermost has been published to preview environment for Git SHA fe2ea24 |
|
Newest code from mattermost has been published to preview environment for Git SHA e221c46 |
No description provided.