V11.8 Docs#8974
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:
📝 WalkthroughWalkthroughThis PR updates documentation: clarifies Report a Problem Default behavior and fixes its env var name, adds mobile-app log troubleshooting with the ChangesDocumentation Updates
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels: 🚥 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 v11.8 documentation version.
Changes:
- Bumps the commented
versionvalue from11.7to11.8insource/conf.py. - Bumps the commented
releasevalue from11.7to11.8insource/conf.py.
|
Newest code from mattermost has been published to preview environment for Git SHA 53db6b0 |
* MM-67771: Update Report a Problem docs to reflect email flow Update the "Default link" description to reflect the new behavior: licensed servers now open an email to Mattermost support, and free edition directs to the troubleshooting forums. Also fix typo in REPORTAPROBLMEMAIL env var name. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Update site-configuration-settings.rst --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Eric Sethna <14333569+esethna@users.noreply.github.com> Co-authored-by: Amy Blais <29708087+amyblais@users.noreply.github.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@source/conf.py`:
- Around line 529-531: Uncomment the Sphinx version settings by removing the
comment markers so the variables version and release are assigned (i.e., change
the commented lines for version = '11.8' and release = '11.8' to active
assignments) in source/conf.py so Sphinx can substitute |version| and |release|
in the docs.
🪄 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: a570f205-7bcb-411a-9a9b-7f041d5976a9
📒 Files selected for processing (2)
source/administration-guide/configure/site-configuration-settings.rstsource/conf.py
|
Newest code from mattermost has been published to preview environment for Git SHA 328fc1e |
|
Newest code from mattermost has been published to preview environment for Git SHA bec05d0 |
* docs: add /mobile-logs slash command Document the new /mobile-logs command introduced in mattermost/mattermost#35658, which toggles the attach_app_logs preference to enable attaching mobile app logs as a file in the Mattermost mobile client (v2.38+) for debugging. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs: refine /mobile-logs admonition and wording - Elevate security/audit note to .. important:: - Use bold instead of italics for the error message - Clarify the attachment applies to any message the user sends Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * address reviews * docs: refine mobile troubleshooting formatting * improve description --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@source/deployment-guide/mobile/mobile-troubleshooting.rst`:
- Line 168: Standardize the session menu label wording on this page by choosing
one of the two variants and updating all occurrences to match; replace either
"View and Log Out of Active Sessions" or "View and Logout of Active Sessions" so
the label is consistent (ensure both the line around the DeviceId/Sessions
explanation and the earlier reference use the same string), and follow
Mattermost's standard UI label casing/spacing when making the change.
🪄 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: c5f9c96c-384e-42aa-9b67-57184e0c79bf
📒 Files selected for processing (2)
source/deployment-guide/mobile/mobile-troubleshooting.rstsource/integrations-guide/built-in-slash-commands.rst
✅ Files skipped from review due to trivial changes (1)
- source/integrations-guide/built-in-slash-commands.rst
|
Newest code from mattermost has been published to preview environment for Git SHA 89c8271 |
|
Newest code from mattermost has been published to preview environment for Git SHA 91d11f7 |
|
Newest code from mattermost has been published to preview environment for Git SHA 3ebc52d |
|
Newest code from mattermost has been published to preview environment for Git SHA e9ffec4 |
|
Newest code from mattermost has been published to preview environment for Git SHA aee36a1 |
|
Newest code from mattermost has been published to preview environment for Git SHA 3b1a5de |
|
Newest code from mattermost has been published to preview environment for Git SHA 7a5c45f |
|
Newest code from mattermost has been published to preview environment for Git SHA 96d6881 |
* Added docs for deletion summary feature * Review fixes
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@source/administration-guide/manage/admin/content-flagging.rst`:
- Line 96: Replace the absolute phrasing "When a reviewer permanently removes a
quarantined message, the message and all associated data are deleted from the
database and file system and can't be recovered." with a qualified statement
that limits the scope to active storage and references backups, e.g. state that
the message and associated data are deleted from the active database and
configured file storage and that recovery may still be possible from backups or
snapshots according to the organization’s retention and restore policies; update
the sentence in content-flagging.rst (the line starting "When a reviewer
permanently removes a quarantined message...") to this qualified wording.
- Line 134: The report filename placeholder is inconsistent: replace all
occurrences of deletion_report_<postId>.md with the preferred
deletion_report_<post_id>.md so the documentation uses a single, consistent
placeholder; update the instance in the sentence that currently reads
``deletion_report_<postId>.md`` to ``deletion_report_<post_id>.md`` (matching
the earlier mention) so both references (the one at line 111 and the one at line
134) are identical.
🪄 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: 792056f9-1d49-40df-9574-3b6c79405751
📒 Files selected for processing (1)
source/administration-guide/manage/admin/content-flagging.rst
|
Newest code from mattermost has been published to preview environment for Git SHA 7cfe254 |
|
Newest code from mattermost has been published to preview environment for Git SHA 7644323 |
|
Newest code from mattermost has been published to preview environment for Git SHA f4913ee |
|
Newest code from mattermost has been published to preview environment for Git SHA e040edd |
|
Newest code from mattermost has been published to preview environment for Git SHA 42b5642 |
|
Newest code from mattermost has been published to preview environment for Git SHA 2b14ed0 |
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
source/administration-guide/manage/admin/content-flagging.rst (2)
147-147:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winQualify the irrecoverability statement to account for backups.
Line 147 states that deleted data "can't be recovered," but this is too absolute. Data may still exist in backups or snapshots depending on retention policy.
Suggested correction: "...deleted from the active database and configured file storage. Recovery may still be possible from backups according to your organization's retention and restore policies."
As per coding guidelines, "Flag content that is factually wrong, outdated, misleading, [or] imprecise."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@source/administration-guide/manage/admin/content-flagging.rst` at line 147, The sentence claiming deleted data "can't be recovered" is too absolute; update the text that contains "can't be recovered" to a qualified statement clarifying deletion applies to the active database and configured file storage and that recovery may still be possible from backups or snapshots per retention/restore policies (e.g., replace the phrase "can't be recovered" with "may still be recoverable from backups or snapshots depending on your organization's retention and restore policies" to ensure accuracy).Source: Coding guidelines
185-185:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winUse consistent report filename placeholder.
Line 185 uses
deletion_report_<postId>.md, but line 162 usesdeletion_report_<post_id>.md. Maintain one consistent format throughout (prefer<post_id>with underscore) to avoid operator confusion during escalation.Minimal diff
-Reviewers should escalate to a System Administrator, who can use the attached ``deletion_report_<postId>.md`` file - including the full per-step error log - to perform manual remediation and confirm that the data is fully removed. +Reviewers should escalate to a System Administrator, who can use the attached ``deletion_report_<post_id>.md`` file - including the full per-step error log - to perform manual remediation and confirm that the data is fully removed.As per coding guidelines, "Ensure product names, UI labels, config names, and feature terms match Mattermost's standard language."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@source/administration-guide/manage/admin/content-flagging.rst` at line 185, The report filename placeholder is inconsistent: replace the occurrence of "deletion_report_<postId>.md" with the preferred "deletion_report_<post_id>.md" so it matches the other mention and Mattermost naming conventions; search for the strings "deletion_report_<postId>.md" and "deletion_report_<post_id>.md" in this document (e.g., around the sentence referencing the attached deletion report) and unify them to "deletion_report_<post_id>.md".Source: Coding guidelines
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@source/administration-guide/manage/admin/content-flagging.rst`:
- Around line 111-112: The tip text that currently says "Once a message is
removed, its content, attachments, and edit history are permanently deleted and
can't be recovered." is too absolute; update that sentence in the
content-flagging tip to qualify irrecoverability by stating that deletion
removes data from the application and user interfaces and is not recoverable via
the app, but copies may still exist in backups, snapshots, or legal/archive
systems per the organization's retention policy; also add a brief recommendation
to verify backup and retention/hold policies before deleting.
---
Duplicate comments:
In `@source/administration-guide/manage/admin/content-flagging.rst`:
- Line 147: The sentence claiming deleted data "can't be recovered" is too
absolute; update the text that contains "can't be recovered" to a qualified
statement clarifying deletion applies to the active database and configured file
storage and that recovery may still be possible from backups or snapshots per
retention/restore policies (e.g., replace the phrase "can't be recovered" with
"may still be recoverable from backups or snapshots depending on your
organization's retention and restore policies" to ensure accuracy).
- Line 185: The report filename placeholder is inconsistent: replace the
occurrence of "deletion_report_<postId>.md" with the preferred
"deletion_report_<post_id>.md" so it matches the other mention and Mattermost
naming conventions; search for the strings "deletion_report_<postId>.md" and
"deletion_report_<post_id>.md" in this document (e.g., around the sentence
referencing the attached deletion report) and unify them to
"deletion_report_<post_id>.md".
🪄 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: 0d8d8528-d58a-4165-8b91-3a30cd526f7a
📒 Files selected for processing (1)
source/administration-guide/manage/admin/content-flagging.rst
|
Newest code from mattermost has been published to preview environment for Git SHA 8cba82e |
No description provided.