Skip to content

BHCS317-Update-Permissions-Article #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

handplaned
Copy link
Contributor

@handplaned handplaned commented Jun 18, 2025

Closes BHCS317
https://specterops.atlassian.net/issues/BHCS-317

Updated SharpHound permissions page with generic language, updated pill images.
Moved page up one level, updated menu and all references.

Summary by CodeRabbit

  • Documentation
    • Updated references and links for SharpHound data collection and permissions to a unified, general location covering both Enterprise and Community Editions.
    • Revised document titles, descriptions, and images to clarify applicability to both editions.
    • Improved formatting and navigation structure for easier access and clarity.
    • Removed redundant or outdated cards and links related to Enterprise-only documentation.

@handplaned handplaned self-assigned this Jun 18, 2025
@handplaned handplaned added the documentation Improvements or additions to documentation label Jun 18, 2025
Copy link
Contributor

coderabbitai bot commented Jun 18, 2025

Walkthrough

Documentation was updated to unify and generalize the "SharpHound Data Collection and Permissions" content, making it applicable to both BloodHound Enterprise and Community Edition. Multiple internal and navigation links were updated to reference the new, centralized permissions page location. Related cards and references specific to the Enterprise collection were removed or modified for consistency.

Changes

Files/Paths Change Summary
docs/collect-data/enterprise-collection/ad-hoc-collection.mdx
docs/collect-data/enterprise-collection/collection-schedule.mdx
docs/collect-data/enterprise-collection/on-demand-scan.mdx
docs/collect-data/enterprise-collection/overview.mdx
Updated or removed links referencing the old Enterprise permissions page; removed related card.
docs/collect-data/overview.mdx Removed "SharpHound Enterprise Data Collection and Permissions" card from overview.
docs/collect-data/permissions.mdx Generalized and reformatted content to cover both Enterprise and Community Editions; updated metadata and links.
docs/docs.json Moved "permissions" page to higher-level "Collect Data" group in navigation.
docs/get-started/security-boundaries/enterprise-security-overview.mdx Updated permissions link to new centralized location.
docs/install-data-collector/install-sharphound/system-requirements.mdx
docs/install-data-collector/install-sharphound/tenant-configuration.mdx
docs/install-data-collector/install-sharphound/troubleshooting.mdx
Updated all links to point to the new permissions documentation path.

Poem

🐇
A hop and a skip, the docs rearranged,
Links unified, permissions exchanged.
No more confusion, no more divide,
Enterprise and Community, side by side.
With every path now clear and bright,
The rabbit cheers, “The docs are right!”
📚✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7718280 and 1f5d7fe.

📒 Files selected for processing (1)
  • docs/collect-data/enterprise-collection/on-demand-scan.mdx (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • docs/collect-data/enterprise-collection/on-demand-scan.mdx

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.

❤️ Share
🪧 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 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
docs/collect-data/permissions.mdx (1)

12-12: Suggest adding comma after introductory phrase
Consider writing “In BloodHound Enterprise, you can start scans…” for clarity.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4ea31c1 and 7718280.

📒 Files selected for processing (12)
  • docs/collect-data/enterprise-collection/ad-hoc-collection.mdx (1 hunks)
  • docs/collect-data/enterprise-collection/collection-schedule.mdx (1 hunks)
  • docs/collect-data/enterprise-collection/on-demand-scan.mdx (1 hunks)
  • docs/collect-data/enterprise-collection/overview.mdx (0 hunks)
  • docs/collect-data/overview.mdx (0 hunks)
  • docs/collect-data/permissions.mdx (2 hunks)
  • docs/docs.json (1 hunks)
  • docs/get-started/security-boundaries/enterprise-security-overview.mdx (1 hunks)
  • docs/install-data-collector/install-sharphound/system-requirements.mdx (2 hunks)
  • docs/install-data-collector/install-sharphound/tenant-configuration.mdx (1 hunks)
  • docs/install-data-collector/install-sharphound/troubleshooting.mdx (1 hunks)
  • docs/integrations/integrations/overview.mdx (1 hunks)
💤 Files with no reviewable changes (2)
  • docs/collect-data/enterprise-collection/overview.mdx
  • docs/collect-data/overview.mdx
🧰 Additional context used
🪛 LanguageTool
docs/collect-data/permissions.mdx

[uncategorized] ~12-~12: Possible missing comma found.
Context: ...rprise Engineering team. In BloodHound Enterprise you can start scans for different data ...

(AI_HYDRA_LEO_MISSING_COMMA)

🔇 Additional comments (15)
docs/integrations/integrations/overview.mdx (1)

30-30: ServiceHound entry looks good.

The new community integration follows the existing formatting and link pattern.

docs/collect-data/permissions.mdx (4)

2-5: Frontmatter updated correctly
The title, sidebarTitle, mode, and description have been adjusted to reflect the unified page.


8-8: Pill image reflects both editions
The updated image tag and alt text correctly indicate applicability to Enterprise and Community.


17-25: AD data list links updated
All bullets now point to the unified /collect-data/permissions anchors and formatting is consistent.


104-104: Clarification note addition
The new callout about DC Registry and CA Registry enhances discoverability without altering technical accuracy.

docs/get-started/security-boundaries/enterprise-security-overview.mdx (1)

187-187: Updated SharpHound link
The Data Collection Overview now accurately directs users to the unified permissions page.

docs/install-data-collector/install-sharphound/troubleshooting.mdx (2)

5-5: Pill image updated correctly
The pill tag now covers both Enterprise and CE, matching the unified scope.


7-7: Troubleshooting link updated
The hyperlink correctly points to /collect-data/permissions with appropriate link text.

docs/install-data-collector/install-sharphound/tenant-configuration.mdx (1)

49-49: Data link updated in table
The “Data (Required)” row now references the unified permissions page as intended.

docs/collect-data/enterprise-collection/collection-schedule.mdx (1)

39-39: Update link to generic permissions page
The link now correctly points to the unified /collect-data/permissions page after moving it out of the Enterprise directory.

docs/docs.json (1)

84-84: Add generic permissions page to navigation
Including "collect-data/permissions" at the top level under the Collect Data group ensures unified access to the permissions documentation. Double-check that there are no lingering references to the old Enterprise-specific path.

docs/collect-data/enterprise-collection/ad-hoc-collection.mdx (1)

37-37: Update link to generic permissions documentation
The reference has been updated to point at /collect-data/permissions, reflecting the moved and renamed page.

docs/install-data-collector/install-sharphound/system-requirements.mdx (3)

49-49: Update DC Registry link anchor to new permissions page
The anchor now points to /collect-data/permissions#01HR6PT0BG44W65EJJ0WE4H63V. Please verify that this ID matches the target heading in permissions.mdx.


61-61: Update DC Registry collection permissions link
Link correctly updated to /collect-data/permissions. Ensure the target page covers DC Registry requirements.


65-65: Update general permissions reference
The final reference now points to /collect-data/permissions. Confirm that this page contains the complete, consolidated requirement information.

@handplaned handplaned merged commit 4e82502 into SpecterOps:main Jun 18, 2025
2 checks passed
@handplaned handplaned deleted the BHCS-317-sharphound-permissions-article branch June 18, 2025 19:25
@github-actions github-actions bot locked and limited conversation to collaborators Jun 18, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants