Skip to content

Added docs for deletion summary feature#8933

Open
harshilsharma63 wants to merge 2 commits intomasterfrom
data_spillage_deletion_summary
Open

Added docs for deletion summary feature#8933
harshilsharma63 wants to merge 2 commits intomasterfrom
data_spillage_deletion_summary

Conversation

@harshilsharma63
Copy link
Copy Markdown
Member

Summary

Added docs for data spillage deletion summary feature

Ticket Link

Fixes https://mattermost.atlassian.net/browse/MM-68626

Copilot AI review requested due to automatic review settings May 4, 2026 12:35
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 4, 2026

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: 7bda43da-c4ce-4af6-b8c4-935e7dc30933

📥 Commits

Reviewing files that changed from the base of the PR and between 11b87d2 and b615f94.

📒 Files selected for processing (1)
  • source/administration-guide/manage/admin/content-flagging.rst
✅ Files skipped from review due to trivial changes (1)
  • source/administration-guide/manage/admin/content-flagging.rst

📝 Walkthrough

Walkthrough

Updated the content-flagging admin guide: expanded the "Deleted messages" section to enumerate all data categories removed when a quarantined message is permanently deleted, and added a "Post deletion report" section describing the Data Spillage Bot's per-reviewer audit report, status outcomes, remediation guidance, and an audit retention note.

Changes

Content Deletion and Reporting Documentation

Layer / File(s) Summary
Expanded Deletion Scope
source/administration-guide/manage/admin/content-flagging.rst
Replaced a concise deletion description with a detailed checklist of deleted/scrubbed data: post record (scrubbed content), file attachments and DB records, edit-history revisions and metadata, priority metadata, persistent notifications, acknowledgements, reminders, and thread/reply/reaction data.
Post Deletion Report
source/administration-guide/manage/admin/content-flagging.rst
Added a section describing that when a reviewer removes a quarantined message the Data Spillage Bot posts an auditable, per-reviewer report thread containing an inline summary and an attached deletion_report_<postId>.md file, with per-step cleanup results.
Status Outcomes & Remediation Guidance
source/administration-guide/manage/admin/content-flagging.rst
Documented per-step status values (Removed, Not applicable, Partial, Failed), guidance to escalate partial/failed steps to a System Administrator, and use of the attached report for manual remediation.
Audit Retention Note
source/administration-guide/manage/admin/content-flagging.rst
Added note that the deletion report is the single source of truth for post-removal auditing and the review thread should be retained per audit policy.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Added docs for deletion summary feature' accurately summarizes the main change: documentation updates for the deletion summary feature.
Description check ✅ Passed The description is directly related to the changeset, explaining that it adds documentation for the data spillage deletion summary feature and references the relevant ticket.
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 data_spillage_deletion_summary

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

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 the current code and only fix it if needed.

Inline comments:
In `@source/administration-guide/manage/admin/content-flagging.rst`:
- Around line 132-138: The guidance under "When any step reports **Partial** or
**Failed**" and the note about the post deletion report being the single source
of truth should use stronger admonitions: replace the paragraph that begins
"When any step reports **Partial** or **Failed**..." with a .. warning:: block
that clearly signals escalation and use of the attached
deletion_report_<postId>.md for remediation, and change the existing ".. note::"
paragraph that starts "The post deletion report is the single source of
truth..." to an .. important:: admonition to emphasize audit-retention
requirements; ensure the text content remains the same but wrapped in the new
admonition directives.
🪄 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: 61d61f1f-428e-4fa2-83f7-a4d83ce0acfb

📥 Commits

Reviewing files that changed from the base of the PR and between 560c09f and 11b87d2.

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

Comment thread source/administration-guide/manage/admin/content-flagging.rst
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

Adds administrator documentation for the Data Spillage Handling “post deletion report” (deletion summary) that’s generated when reviewers remove quarantined messages, and expands the documented scope of what gets deleted.

Changes:

  • Reworks the “Deleted messages” section to enumerate specific data and metadata removed during quarantine-based deletion.
  • Adds a new “Post deletion report” section describing the report content, attached artifact, and step status meanings.
  • Adds retention guidance for audit purposes.

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

github-actions Bot commented May 4, 2026

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 5, 2026

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

@harshilsharma63 harshilsharma63 requested a review from marianunez May 6, 2026 02:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants