Add PII protection documentation

[devin-ai-integration]

Add PII protection documentation

Summary

This PR adds comprehensive documentation for Elementary's PII protection features that were implemented in PR #831 (table-level protection) and mentions PR #833 (column-level protection). The new documentation file covers:

• How PII protection works by disabling test sample collection
• Configuration variables (disable_samples_on_pii_tags, pii_tags)
• Usage examples for table-level and individual test protection
• Configuration precedence and verification steps
• Future enhancements for column-level protection

The documentation is based on code inspection of the implementation in the dbt-data-reliability repository, particularly the logic in macros/edr/materializations/test/test.sql and macros/edr/system/system_utils/is_pii_table.sql.

Review & Testing Checklist for Human

• Test PII protection functionality - Verify that the documented configuration actually works by setting up a test model with PII tags and confirming sample collection is disabled
• Validate configuration examples - Check that variable names (disable_samples_on_pii_tags, pii_tags) and default values are correct in the actual codebase
• Review documentation accuracy - Ensure the behavior description matches real implementation, especially the configuration precedence rules
• Check documentation style consistency - Verify the new file matches the format, tone, and structure of existing docs in the /data-tests/ directory
• Verify PR [ELE-735] Add an exception when anomaly detection test is configured on ephemeral model #833 status - Confirm whether column-level protection was actually implemented or is still pending (I couldn't find the expected implementation files)

Recommended test plan: Set up a test dbt project with Elementary, tag a model with pii, enable disable_samples_on_pii_tags: true, run tests, and verify that no sample rows are collected in the elementary_test_results table.

---

Diagram

%%{ init : { "theme" : "default" }}%%
graph TD
    subgraph "Elementary Documentation"
        DocsTests["docs/data-tests/"]:::context
        PIIDoc["docs/data-tests/pii-protection.mdx"]:::major-edit
        ExistingDocs["*.mdx files"]:::context
    end
    
    subgraph "dbt-data-reliability Implementation"
        TestMat["macros/edr/materializations/test/test.sql"]:::context
        PIITable["macros/edr/system/system_utils/is_pii_table.sql"]:::context
        ConfigVar["macros/edr/system/system_utils/get_config_var.sql"]:::context
    end
    
    subgraph "User Configuration"
        DBTProject["dbt_project.yml vars"]:::context
        ModelSchema["models/schema.yml tags"]:::context
    end
    
    TestMat --> PIIDoc
    PIITable --> PIIDoc
    ConfigVar --> PIIDoc
    PIIDoc --> DocsTests
    
    subgraph Legend
        L1["Major Edit"]:::major-edit
        L2["Minor Edit"]:::minor-edit
        L3["Context/No Edit"]:::context
    end

classDef major-edit fill:#90EE90
classDef minor-edit fill:#87CEEB
classDef context fill:#FFFFFF

Loading

Notes

• This documentation was created by @arbiv's request to document features from PR Tests docs #831 and PR [ELE-735] Add an exception when anomaly detection test is configured on ephemeral model #833
• Link to Devin run: https://app.devin.ai/sessions/b6661a60808a40db87f6048c4c9d35df
• Requested by: @arbiv
• The documentation is based on code inspection rather than hands-on testing, so accuracy verification is important
• Column-level protection (PR [ELE-735] Add an exception when anomaly detection test is configured on ephemeral model #833) appears to not be fully implemented yet, as expected implementation files were not found
• The new documentation file follows the existing .mdx format used throughout the Elementary docs

[devin-ai-integration]

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

• Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
• Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

• Disable automatic comment and CI monitoring

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch devin/1754247400-add-pii-protection-docs

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[devin-ai-integration]

Closing due to inactivity for more than 7 days. Configure here.