Skip to content

Clarify bound entitlements documentation#62

Open
mindymo wants to merge 1 commit intomainfrom
clarify-bound-entitlements
Open

Clarify bound entitlements documentation#62
mindymo wants to merge 1 commit intomainfrom
clarify-bound-entitlements

Conversation

@mindymo
Copy link
Collaborator

@mindymo mindymo commented Feb 5, 2026

Summary

Expands documentation for bound entitlements to address customer confusion about what they do and don't do.

Changes

New sections added:

  • How bound entitlements work - Explains source/destination relationship with a key callout that bindings are a visibility layer, not provisioning
  • What bound entitlements do / don't do - Clear lists addressing the main point of confusion
  • Types of bindings - System-managed vs manual
  • When to use bound entitlements - Three concrete use cases with examples:
    • Role hierarchies within an application
    • Cross-application access dependencies
    • Nested group memberships
  • Access reviews with bound entitlements - How derived access appears and can be revoked

Updated:

  • Bound entitlements overview in "Choosing the right tool" section

Preserved:

  • All existing procedural content (linked entitlements, manual bindings, virtual entitlements)

What was cut from the source material

The source material included implementation details (DAG structure, uplift process, delegated provisioning internals, API examples, glossary) that aren't necessary for customers to understand how to use the feature.

Test plan

  • Verify page renders correctly
  • Check Note component displays properly
  • Review examples for clarity

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Enhanced documentation for entitlement relationship tooling with expanded clarity on bound entitlements functionality
    • Added new comprehensive section detailing how bound entitlements work, including definitions, usage examples, and binding types
    • Improved setup instructions for configuring bindings and linked entitlements with refined explanations
    • Clarified behavior descriptions and provisioning details for enhanced user understanding

Expands the bound entitlements section to address customer confusion:
- Explains what bound entitlements do and don't do (key distinction: visibility layer, not provisioning)
- Adds system-managed vs manual binding types
- Provides concrete use cases (role hierarchies, cross-app dependencies, nested groups)
- Clarifies access review behavior with derived access

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 5, 2026

📝 Walkthrough

Walkthrough

Documentation for entitlement relationship tooling was expanded with a new "How bound entitlements work" section, including definitions, usage examples, provisioning behavior notes, and clarified step-by-step setup instructions with refined wording throughout.

Changes

Cohort / File(s) Summary
Documentation Update
product/admin/relationships.mdx
Expanded entitlement relationship documentation with new "How bound entitlements work" section, added concrete examples for role hierarchies and cross-application dependencies, clarified source/destination semantics, visibility, auditing, and provisioning behavior, refined setup instructions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A guide so clear, now bound with care,
Entitlements dance through the air,
With examples bright and steps refined,
The admin's path is now aligned! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Clarify bound entitlements documentation' is directly related to the main change—expanding and clarifying the entitlement relationship tooling documentation with new sections and refined explanations.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch clarify-bound-entitlements

Comment @coderabbitai help to get the list of available commands and usage tips.

@mindymo
Copy link
Collaborator Author

mindymo commented Feb 5, 2026

@OneWhoNests @harikac1 Here's an updated draft of the entitlement bindings doc, integrating a pared-down version of the info Nestor sent me. Can you please give this a quick review and flag anything that you think we still need to change/update/expand to help customers understand bound entitlements? Many thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant