feat(docs): document Resource Mapping Groups and FQN format#350
feat(docs): document Resource Mapping Groups and FQN format#350marythought wants to merge 5 commits into
Conversation
|
Warning Review limit reached
More reviews will be available in 58 minutes and 30 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate. For paid Pro and Pro+ PR reviews, CodeRabbit uses rolling per-developer review limits. Reviews become available again as older review attempts age out of the rolling limit window. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughDocumentation for ChangesResource Mapping Groups Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Code Review
This pull request updates the documentation for Resource Mappings to introduce Resource Mapping Groups, explaining their purpose, FQN format, CLI commands for creation, and usage as synonym dictionaries. It also fixes a minor typo in an example URL. The reviewer suggested using the .md extension for relative file links to ensure build-time validation in Docusaurus and compatibility with standard Markdown readers.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
|
❌ Surge preview build failed — no preview was deployed. Check the workflow logs for details. Once the build passes, the preview will be at: https://opentdf-docs-pr-350.surge.sh Common cause: If the build failed on vendored YAML validation, run the following locally and commit the result: |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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 `@docs/components/policy/resource_mappings.md`:
- Line 33: Add language specifiers to the fenced code blocks to comply with the
MD040 linting rule. Locate the two code blocks containing the FQN examples (at
the lines with the namespace/resm examples) and change the opening triple
backticks from ``` to ```text for both blocks to provide proper syntax
highlighting and satisfy the linting requirement.
🪄 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: c09b1cf2-2226-495e-a860-ddeb169196a8
📒 Files selected for processing (1)
docs/components/policy/resource_mappings.md
Add Resource Mapping Groups section to the resource_mappings page covering group composition, FQN format (https://<namespace>/resm/<name>), CLI usage for creating groups and assigning mappings, and usage as synonym dictionaries. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Address Gemini and CodeRabbit review feedback: - Use ./attributes.md#namespaces for build-time link validation - Add text language specifier to FQN code blocks (MD040) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
845401f to
0faf858
Compare
|
📄 Preview deployed to https://opentdf-docs-pr-350.surge.sh |
Tie the CLI example to Bob's DoD classification scenario from earlier in the page instead of using generic placeholders. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Summary
https://<namespace>/resm/<group-name>)This gap was identified when the FQN format could not be found in any documentation or CLI output, requiring engineers to read source code to discover it.
Test plan
npm run buildpasseslib/identifier/resource_mapping_group.go)🤖 Generated with Claude Code
Summary by CodeRabbit
groupfield and clarified the “Examples” section structure.