Skip to content

V11.8 Docs#8974

Open
amyblais wants to merge 13 commits into
masterfrom
v11.8-documentation
Open

V11.8 Docs#8974
amyblais wants to merge 13 commits into
masterfrom
v11.8-documentation

Conversation

@amyblais
Copy link
Copy Markdown
Member

No description provided.

Copilot AI review requested due to automatic review settings May 15, 2026 06:42
@amyblais amyblais added this to the v11.8.0 milestone May 15, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 15, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 8cc1757d-d80a-4df7-850b-c81a080f9396

📥 Commits

Reviewing files that changed from the base of the PR and between 7cfe254 and 7644323.

📒 Files selected for processing (1)
  • source/conf.py
✅ Files skipped from review due to trivial changes (1)
  • source/conf.py

📝 Walkthrough

Walkthrough

This PR updates documentation: clarifies Report a Problem Default behavior and fixes its env var name, adds mobile-app log troubleshooting with the /mobile-logs command, expands deleted-message deletion/reporting details, tweaks a slash-command list entry, and bumps the Sphinx docs version to 11.8.

Changes

Documentation Updates

Layer / File(s) Summary
Report a Problem configuration documentation
source/administration-guide/configure/site-configuration-settings.rst
Updated the Default option to document license-based behaviour (licensed deployments open a support case by email; unlicensed deployments are directed to troubleshooting forums). Corrected the environment variable name from MM_SUPPORTSETTINGS_REPORTAPROBLMEMAIL to MM_SUPPORTSETTINGS_REPORTAPROBLEMMAIL in the setting metadata and the reference table.
Mobile app logs troubleshooting & push notifications
source/deployment-guide/mobile/mobile-troubleshooting.rst
Added a new subsection describing the /mobile-logs command (on, off, status, optional @username), app-version and non-admin targeting notes (non-enumeration response and audit logging). Also adjusted DeviceId code markup in push-notification guidance.
Deleted messages & post deletion report
source/administration-guide/manage/admin/content-flagging.rst
Replaced prior brief deletion bullets with a detailed deletion scope list and added a “Post deletion report” subsection describing per-step statuses, localization/delivery behaviour, and escalation steps referencing an attached deletion_report_<post_id>.md.
Slash commands list minor edit & Sphinx version bump
source/integrations-guide/built-in-slash-commands.rst, source/conf.py
Adjusted the placement/markup of the /logout bullet under “More useful slash commands” (content unchanged). Updated Sphinx version and release comment values from 11.7 to 11.8.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • mattermost/docs#8913: Also updates source/deployment-guide/mobile/mobile-troubleshooting.rst to cover the /mobile-logs command.
  • mattermost/docs#8845: Also updates Report a Problem documentation and renames MM_SUPPORTSETTINGS_REPORTAPROBLMEMAILMM_SUPPORTSETTINGS_REPORTAPROBLEMMAIL.
  • mattermost/docs#8933: Overlaps with the expanded “Deleted messages” documentation and the new “Post deletion report” content.
🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'V11.8 Docs' is vague and generic, using only a version number without describing the specific documentation changes made. Replace with a more descriptive title that summarizes the main changes, such as 'Update documentation for V11.8 release including Report a Problem config, mobile logs, and content flagging'.
Description check ❓ Inconclusive No pull request description was provided by the author, making it impossible to assess whether documentation intent was explained. Add a pull request description explaining the purpose of the V11.8 documentation updates and the key changes across all affected documentation files.
✅ 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 docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch v11.8-documentation

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

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

@amyblais amyblais added the Work In Progress Not yet ready for review label May 15, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Sphinx documentation configuration to reflect the Mattermost v11.8 documentation version.

Changes:

  • Bumps the commented version value from 11.7 to 11.8 in source/conf.py.
  • Bumps the commented release value from 11.7 to 11.8 in source/conf.py.

@github-actions
Copy link
Copy Markdown
Contributor

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>
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 84ccd00 and 328fc1e.

📒 Files selected for processing (2)
  • source/administration-guide/configure/site-configuration-settings.rst
  • source/conf.py

Comment thread source/conf.py
@github-actions
Copy link
Copy Markdown
Contributor

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

@github-actions
Copy link
Copy Markdown
Contributor

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>
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 328fc1e and 89c8271.

📒 Files selected for processing (2)
  • source/deployment-guide/mobile/mobile-troubleshooting.rst
  • source/integrations-guide/built-in-slash-commands.rst
✅ Files skipped from review due to trivial changes (1)
  • source/integrations-guide/built-in-slash-commands.rst

Comment thread source/deployment-guide/mobile/mobile-troubleshooting.rst
@github-actions
Copy link
Copy Markdown
Contributor

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

@github-actions
Copy link
Copy Markdown
Contributor

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

@github-actions
Copy link
Copy Markdown
Contributor

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

@github-actions
Copy link
Copy Markdown
Contributor

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

@github-actions
Copy link
Copy Markdown
Contributor

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

@github-actions
Copy link
Copy Markdown
Contributor

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

@github-actions
Copy link
Copy Markdown
Contributor

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

@github-actions
Copy link
Copy Markdown
Contributor

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

* Added docs for deletion summary feature

* Review fixes
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 89c8271 and 7cfe254.

📒 Files selected for processing (1)
  • source/administration-guide/manage/admin/content-flagging.rst

Comment thread source/administration-guide/manage/admin/content-flagging.rst
Comment thread source/administration-guide/manage/admin/content-flagging.rst
@github-actions
Copy link
Copy Markdown
Contributor

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Work In Progress Not yet ready for review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants