Added docs for data spillage report generation#8934
Added docs for data spillage report generation#8934harshilsharma63 wants to merge 1 commit intomasterfrom
Conversation
There was a problem hiding this comment.
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.
|
Newest code from mattermost has been published to preview environment for Git SHA 140ef27 |
📝 WalkthroughWalkthroughDocumentation 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. ChangesQuarantined Message Reporting Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
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
📒 Files selected for processing (1)
source/administration-guide/manage/admin/content-flagging.rst
Summary
Added docs for data spillage report generation feature
Ticket Link
Fixes https://mattermost.atlassian.net/browse/MM-68522