BED-7061 docs: Update HelpTexts for AZ role edges #137
Conversation
WalkthroughThis PR modernizes documentation terminology across eight Azure/Entra ID edge resource files, replacing generic role names with standardized "Entra ID role" phrasing and adding corresponding Microsoft Entra built-in roles references throughout. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes These are homogeneous documentation updates following a consistent pattern of terminology modernization. All changes are editorial, involving description rewording and reference additions with no functional logic alterations. Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/resources/edges/az-role-approver.mdx (1)
14-14: Optional: Consider simplifying "prior to".The phrase "prior to becoming effective" could be simplified to "before becoming effective" for improved readability, though this is a minor stylistic suggestion.
-When a role has an approver for actions, these actions will require a predesignated principal to approve the action prior to becoming effective. +When a role has an approver for actions, these actions will require a predesignated principal to approve the action before becoming effective.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
docs/resources/edges/az-app-admin.mdx(2 hunks)docs/resources/edges/az-cloud-app-admin.mdx(2 hunks)docs/resources/edges/az-global-admin.mdx(2 hunks)docs/resources/edges/az-has-role.mdx(1 hunks)docs/resources/edges/az-privileged-auth-admin.mdx(2 hunks)docs/resources/edges/az-privileged-role-admin.mdx(1 hunks)docs/resources/edges/az-role-approver.mdx(1 hunks)docs/resources/edges/az-role-eligible.mdx(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: jeff-matthews
Repo: SpecterOps/bloodhound-docs PR: 89
File: docs/resources/edges/az-role-approver.mdx:14-14
Timestamp: 2025-10-27T15:00:33.251Z
Learning: In the bloodhound-docs repository, documentation content derived from HelpTexts in the code should not be editorially changed unless there's an egregious error. Minor stylistic improvements should be submitted as PRs to the source code instead of being made directly in the documentation.
Learnt from: StephenHinck
Repo: SpecterOps/bloodhound-docs PR: 42
File: docs/install-data-collector/install-azurehound/system-requirements.mdx:70-73
Timestamp: 2025-08-08T15:57:55.743Z
Learning: For AzureHound docs (docs/install-data-collector/install-azurehound/system-requirements.mdx), prefer explicitly stating:
- Directory Reader must be permanently active (not PIM-eligible only).
- Microsoft Graph application permissions (Directory.Read.All, RoleManagement.Read.All) require admin consent.
- Azure Reader role phrasing: “on all Azure subscriptions, ideally assigned at the tenant root group (root management group) scope.”
📚 Learning: 2025-08-08T15:57:55.743Z
Learnt from: StephenHinck
Repo: SpecterOps/bloodhound-docs PR: 42
File: docs/install-data-collector/install-azurehound/system-requirements.mdx:70-73
Timestamp: 2025-08-08T15:57:55.743Z
Learning: For AzureHound docs (docs/install-data-collector/install-azurehound/system-requirements.mdx), prefer explicitly stating:
- Directory Reader must be permanently active (not PIM-eligible only).
- Microsoft Graph application permissions (Directory.Read.All, RoleManagement.Read.All) require admin consent.
- Azure Reader role phrasing: “on all Azure subscriptions, ideally assigned at the tenant root group (root management group) scope.”
Applied to files:
docs/resources/edges/az-has-role.mdxdocs/resources/edges/az-privileged-role-admin.mdxdocs/resources/edges/az-privileged-auth-admin.mdxdocs/resources/edges/az-app-admin.mdxdocs/resources/edges/az-cloud-app-admin.mdxdocs/resources/edges/az-global-admin.mdx
🪛 LanguageTool
docs/resources/edges/az-role-approver.mdx
[style] ~14-~14: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...ignated principal to approve the action prior to becoming effective. ## References * ht...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
🔇 Additional comments (8)
docs/resources/edges/az-cloud-app-admin.mdx (1)
3-3: LGTM! Terminology and reference updates are consistent.The updated description standardizes the role name to "Cloud Application Administrator Entra ID role" and the added Microsoft Entra reference provides official documentation, both improving clarity and consistency across edge documentation.
Also applies to: 19-19
docs/resources/edges/az-role-eligible.mdx (1)
3-3: LGTM! Enhanced cross-referencing and terminology.The updated description improves clarity by specifying "Entra ID role" and adds a helpful cross-reference to the AZHasRole edge, making it easier for users to understand the relationship between eligibility and active role assignments.
docs/resources/edges/az-global-admin.mdx (1)
3-3: LGTM! Consistent terminology and reference updates.The description now uses the standardized "Global Administrator Entra ID role" terminology, and the added Microsoft Entra reference provides official documentation for this critical role.
Also applies to: 22-22
docs/resources/edges/az-has-role.mdx (1)
3-3: LGTM! Comprehensive terminology standardization and improved cross-referencing.The file consistently updates terminology to "Entra ID role" throughout the description, abuse info, and opsec considerations. The added cross-reference to AZRoleEligible and the updated Entra permissions reference improve documentation quality and navigation.
Also applies to: 10-10, 14-14, 17-17
docs/resources/edges/az-privileged-auth-admin.mdx (1)
3-3: LGTM! Terminology and reference updates are consistent.The description now uses the standardized "Privileged Authentication Administrator Entra ID role" terminology, and the reference text clarification helps users understand the source of the documentation.
Also applies to: 20-20
docs/resources/edges/az-app-admin.mdx (1)
3-3: LGTM! Consistent terminology and reference updates.The description now uses the standardized "Application Administrator Entra ID role" terminology, and the added Microsoft Entra reference provides official documentation for this role.
Also applies to: 20-20
docs/resources/edges/az-role-approver.mdx (1)
3-3: LGTM! Terminology, technical accuracy, and reference improvements.The changes improve the documentation by:
- Standardizing to "Entra ID role" terminology
- Using "principal" instead of "account" for technical consistency with other documentation
- Adding a cross-reference to AZRoleEligible
- Adding the PIM configuration reference
Also applies to: 10-10, 17-17
docs/resources/edges/az-privileged-role-admin.mdx (1)
3-3: LGTM! Terminology, content enhancement, and reference improvements.The changes improve documentation quality by:
- Standardizing to "Privileged Role Administrator Entra ID role" terminology
- Expanding the Abuse Info section with more specific and actionable details about granting admin roles
- Adding the Microsoft Entra reference for official documentation
Also applies to: 11-11, 19-19
martinsohn
changed the title
|
Thanks for the update @martinsohn! |
Fixes the BH Docs part of BED-7061
Summary
Updates help text for Azure Entra ID role edges to improve consistency, clarity, and accuracy.
Changes
Files Modified
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.