QUA-1588: Add field masking documentation for sensitive data protection#1084
Draft
RafaelOsiro wants to merge 10 commits intomainfrom
Draft
QUA-1588: Add field masking documentation for sensitive data protection#1084RafaelOsiro wants to merge 10 commits intomainfrom
RafaelOsiro wants to merge 10 commits intomainfrom
Conversation
… deep dive, and reveal screenshots
RafaelOsiro
requested review from
Hitsu-360,
gasscoelho,
pelegolas9 and
shindiogawa
Greptile SummaryThis PR adds a comprehensive field masking documentation suite — a new concepts page, a masking audit log page, and a dedicated unmask-a-field page — while refactoring the existing Key changes:
Confidence Score: 4/5Safe to merge; one minor wording issue in scan.md that could mislead readers about which operation writes to the enrichment datastore. The PR is well-structured with consistent cross-references, valid image assets, and accurate content throughout. The only actionable issue is a single bullet in scan.md that uses 'remediation' ambiguously and points to the wrong cross-reference for enrichment-datastore masking — a targeted one-line fix resolves it. All other pages are accurate and the new concept/procedural split is a clear improvement. docs/source-datastore/operations/scan.md — the Enrichment Datastore bullet in the 'Field Masking and Scanning' section. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A([Field is Masked]) --> B{Surface}
B --> C[Data Preview]
B --> D[Anomaly Source Records]
B --> E[Quality Check Dry Runs]
B --> F[Field Profile Histograms]
B --> G[Anomaly Assertion Context]
B --> H[Export / Materialize Outputs]
C -->|Editor+| C1[Show masked values button → Reveal\nAudit entry created]
D -->|Editor+| D1[Per-anomaly reveal toggle\nAudit entry created]
E --> E1[Unconditionally masked\nNo reveal available]
F -->|API include_masked=true| F1[Histogram revealed\nAudit entry created]
G --> G1[Unconditionally masked\nNo reveal available]
H -->|API include_masked=true| H1[Actual values in output\nAudit entry created]
A --> I{Unmask Field}
I --> J([Field status → Active\nValues visible everywhere\nNo further audit entries])
Reviews (1): Last reviewed commit: "docs(masking): add field masking context..." | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
…otection Resolve merge conflict in .typos.toml by keeping all custom words Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds comprehensive field masking documentation covering how masking works, where masked values appear across the platform, how to reveal and unmask fields, and the masking audit log for compliance tracking.
Key Changes
mkdocs.ymland field status overview tableLGPDto.typos.tomlallowed wordsTest plan
🤖 Generated with Claude Code