Added docs for exposure report - #9133
Conversation
There was a problem hiding this comment.
Pull request overview
Adds administrator documentation for the new post exposure report within the Data Spillage/content-flagging workflow, to help reviewers understand how to generate the report and interpret its results.
Changes:
- Adds a new “Generate a post exposure report” section describing report purpose, access points, contents, and limitations.
- Updates quarantined message report documentation to include an embedded
exposure_report.csvfile and describe its role. - Adds cross-references from the quarantine review actions list to the new exposure report documentation.
Suppressed comments (1)
source/administration-guide/manage/admin/content-flagging.rst:118
- Editor Evie (Blocker): Under “Generate a quarantined message report”, the sentence “Each report is a ZIP archive …” is now misleading because the post exposure report is a standalone CSV download. This can cause readers to think the exposure report downloads as a ZIP. Clarify that the ZIP applies to the quarantined message report, and that it includes
exposure_report.csv.
Each report is a ZIP archive containing YAML metadata files, a CSV exposure report, and the original file attachments. YAML is used for the metadata files because it's both human-readable and machine-parseable, which makes the report suitable for manual review and for ingestion by downstream compliance or incident-response tooling. The exposure report is CSV so that reviewers can open it directly in a spreadsheet.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe content flagging guide documents exposure reports, including access points, CSV structure, interpretation, limitations, and generation behaviour. Quarantined-message ZIP reports now include ChangesContent flagging reports
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 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 224: Update the public-channel coverage bullet in the content-flagging
documentation to remove the “browsing and joining the channel” example, since
users who join during the reporting window are covered by membership history.
Keep only non-membership access paths, such as permalink previews and
public-channel search without membership.
- Around line 207-214: Update the exposure-classification guidance near the
report metadata comparison to define the message’s valid visibility interval and
classify exposure only when the live “Last viewed channel at” timestamp falls
within that interval; preserve the existing uncertainty guidance for values
outside or missing from the interval. At
source/administration-guide/manage/admin/content-flagging.rst lines 216-216,
limit reproducibility claims to deterministic row ordering and do not describe
live read-state values as immutable report output.
- Line 223: Remove the stray “Ad” text after the email notification contents
reference in the notification delivery paragraph so the sentence ends with
“settings.”
🪄 Autofix
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: 7ad906a8-b81d-46e5-8213-0eb77c1cda23
📒 Files selected for processing (1)
source/administration-guide/manage/admin/content-flagging.rst
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
Newest code from mattermost has been published to preview environment for Git SHA 27b475a |
|
@coderabbitai full review |
✅ Action performedFull review finished. |
|
Newest code from mattermost has been published to preview environment for Git SHA 7becb38 |
|
Newest code from mattermost has been published to preview environment for Git SHA c815d74 |
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
source/administration-guide/manage/admin/content-flagging.rst (1)
138-138: 🗄️ Data Integrity & Integration | 🔵 Trivial | ⚡ Quick winName the archive and CSV versions separately.
Line 138 documents archive format version 1.1, while the CSV example at Line 181 uses
# Report version: 1.0. Without scope labels, readers and importers can treat these values as contradictory. Verify the emitted metadata and document distinct names such asArchive format versionandExposure report version.Suggested wording
-... report format version ... +... archive format version ... - # Report version: 1.0 + # Exposure report version: 1.0Also applies to: 181-181
🤖 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 138, Update the report version documentation near report_metadata.yaml and the exposure_report.csv example to distinguish archive format version from exposure report version, using explicit scope labels. Verify the emitted metadata and ensure the documented values and names match the actual archive and CSV output without implying they are the same version.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 165-168: Add a warning directive immediately after the exposure
report download instructions, stating that reports must be accessible only to
authorised personnel, stored in an approved access-controlled location, and
retained according to the organisation’s retention policy.
- Line 118: Update the report-format description near the ZIP archive statement
to distinguish quarantined message reports from standalone post exposure
reports. State that ZIP archives apply only to quarantined message reports, and
identify the standalone post exposure report as CSV so readers understand the
separate download formats.
---
Nitpick comments:
In `@source/administration-guide/manage/admin/content-flagging.rst`:
- Line 138: Update the report version documentation near report_metadata.yaml
and the exposure_report.csv example to distinguish archive format version from
exposure report version, using explicit scope labels. Verify the emitted
metadata and ensure the documented values and names match the actual archive and
CSV output without implying they are the same version.
🪄 Autofix
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: 14c3a904-afe5-4069-bf3e-5f6761ee66fa
📒 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 7d14792 |
|
LGTM! Thanks, @harshilsharma63! Is this also for v11.11? |
|
@Combs7th yes, its for v11.11 |
|
Newest code from mattermost has been published to preview environment for Git SHA f1b9f9d |
Summary
Added docs for post exposure radius report.
Ticket Link
Fixes https://mattermost.atlassian.net/browse/MM-70063