Skip to content

Added docs for data spillage report generation#8934

Open
harshilsharma63 wants to merge 1 commit intomasterfrom
data_spillage_report
Open

Added docs for data spillage report generation#8934
harshilsharma63 wants to merge 1 commit intomasterfrom
data_spillage_report

Conversation

@harshilsharma63
Copy link
Copy Markdown
Member

Summary

Added docs for data spillage report generation feature

Ticket Link

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

Copilot AI review requested due to automatic review settings May 4, 2026 12:36
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 new quarantined-message report workflow in the Data Spillage Handling docs, extending the existing moderation guide with report-generation behavior and archive contents.

Changes:

  • Documented a new Generate a report action in the quarantined message review flow.
  • Added a new section describing when reviewers can download reports and how the remove/keep dialogs handle report generation.
  • Added a report format section describing the ZIP/YAML archive layout and attachment handling.

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

github-actions Bot commented May 4, 2026

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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 4, 2026

📝 Walkthrough

Walkthrough

Documentation was added to the content flagging administration guide describing how to generate quarantined message reports, including access points from message details and action flows, default behaviours, and the ZIP archive structure with metadata and attachment contents.

Changes

Quarantined Message Reporting Documentation

Layer / File(s) Summary
Report Generation Feature Documentation
source/administration-guide/manage/admin/content-flagging.rst (lines 90–113)
New "Generate a quarantined message report" section explaining report access points (message details page, Remove/Keep message flows), default checkbox behaviour, skip confirmation audit log recording, and failure/retry handling with bot notification to reviewers.
Report Format and Structure Documentation
source/administration-guide/manage/admin/content-flagging.rst (lines 114–143)
New "Report contents and format" subsection detailing ZIP archive layout, YAML metadata files (report_metadata.yaml, content_review.yaml), message post data, attachment deduplication by file ID, and per-edit-history directory entries.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The description clearly relates to the changeset by identifying the feature (data spillage report generation) and providing a ticket reference.
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.
Title check ✅ Passed The title accurately summarizes the main change, which is adding documentation for data spillage report generation.

✏️ 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 data_spillage_report

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: 2

🤖 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 111-112: Replace the low-severity tip admonition with a warning
admonition to reflect permanent data loss: change the existing ".. tip::" block
to ".. warning::" (the admonition that contains the sentence about generating a
report before removing a message) and preserve the text content; ensure
spacing/indentation matches RST admonition syntax so the warning renders
correctly in the admin content-flagging documentation.
- Around line 97-109: The docs for report generation lack guidance on secure
handling of downloaded quarantined-message ZIPs; add a new subsection after the
paragraph mentioning the Data Spillage Bot that explains secure report handling:
state that reports download to the reviewer's local device, recommend storage
and encryption aligned with organizational data-classification policies, specify
retention and secure disposal procedures, and describe access-control and
least-privilege recommendations for production vs development/test environments;
reference the “Download report” flow and “Data Spillage Bot” notification so
reviewers see the guidance in context.
🪄 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: 87f01ad9-d9d9-4783-883e-a075a0d957d4

📥 Commits

Reviewing files that changed from the base of the PR and between 560c09f and 140ef27.

📒 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
@harshilsharma63 harshilsharma63 changed the title Added docs Added docs for data spillage report generation May 5, 2026
@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