Skip to content

BHCS-488-added-reference-servicehound #14

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 BHCS488
https://specterops.atlassian.net/browse/BHCS-488

Add reference link to Eli4m ServiceHound

Summary by CodeRabbit

  • Documentation
    • Added "ServiceHound" to the list of community-developed integrations, including a link to its GitHub repository.
    • Updated and unified SharpHound data collection and permissions documentation to cover both Enterprise and Community Editions.
    • Revised multiple documentation links to point to the consolidated SharpHound Data Collection and Permissions page.
    • Adjusted navigation structure for improved access to data collection permissions content.

@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

A new community integration called "ServiceHound" has been added to the documentation's list of community-developed integrations, including a link to its GitHub repository. Multiple documentation pages had their SharpHound data collection and permissions links updated from an enterprise-specific path to a unified, general path. The "SharpHound Enterprise Data Collection and Permissions" card was removed from overview pages, and the permissions document was generalized to cover both Enterprise and Community editions. Navigation structure was adjusted accordingly. No functional or code changes were made.

Changes

File(s) Change Summary
docs/integrations/integrations/overview.mdx Added "ServiceHound" community integration with GitHub link
docs/collect-data/enterprise-collection/ad-hoc-collection.mdx Updated SharpHound permissions link to general /collect-data/permissions
docs/collect-data/enterprise-collection/collection-schedule.mdx Updated SharpHound permissions link to general /collect-data/permissions
docs/collect-data/enterprise-collection/on-demand-scan.mdx Updated SharpHound permissions link to general /collect-data/permissions
docs/collect-data/enterprise-collection/overview.mdx Removed "SharpHound Enterprise Data Collection and Permissions" card
docs/collect-data/overview.mdx Removed "SharpHound Enterprise Data Collection and Permissions" card
docs/collect-data/permissions.mdx Renamed and generalized document title and content to cover both Enterprise and Community editions; updated links and formatting; clarified collection requirements
docs/docs.json Moved permissions page from "BloodHound Enterprise Collection" subgroup to top-level "Collect Data" group
docs/get-started/security-boundaries/enterprise-security-overview.mdx Updated SharpHound permissions link to general /collect-data/permissions
docs/install-data-collector/install-sharphound/system-requirements.mdx Updated multiple SharpHound permissions links to general /collect-data/permissions
docs/install-data-collector/install-sharphound/tenant-configuration.mdx Updated SharpHound permissions link to general /collect-data/permissions
docs/install-data-collector/install-sharphound/troubleshooting.mdx Updated SharpHound permissions link to general /collect-data/permissions

Possibly related PRs

  • BHCS317-Update-Permissions-Article #15: Updates SharpHound data collection and permissions documentation by generalizing from Enterprise to both Enterprise and Community editions, moving the permissions page, and updating related links, closely related to this PR's documentation restructuring.

Suggested reviewers

  • StephenHinck

Poem

A hound joins the list, wagging with pride,
ServiceHound’s here, with GitHub as guide.
Links realigned, permissions made clear,
Docs unified, for all to revere.
🐾📚✨


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: 0

🧹 Nitpick comments (1)
docs/integrations/integrations/overview.mdx (1)

30-30: Remove trailing whitespace from the new list item

There's an extra space after @Eli4m on line 30; trimming it will keep the formatting consistent with the other entries.

📜 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 cbbf6dd.

📒 Files selected for processing (1)
  • docs/integrations/integrations/overview.mdx (1 hunks)

Copy link
Contributor

@StephenHinck StephenHinck left a comment

Choose a reason for hiding this comment

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

Ship it!

* BHCS-317-update-initial-language

* BHCS-317-updated-menu-and-all-references

* BHCS-317-updated-for-rabbit
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: 0

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

10-12: Fix double space and improve sentence flow.
There’s a double space and a choppy transition between sentences. Consider merging them for clarity.

Proposed diff:

- SharpHound data collection utilizes the open-source [SharpHound Common](https://github.com/BloodHoundAD/SharpHoundCommon) library, maintained by the BloodHound Enterprise Engineering team.  In BloodHound Enterprise you can start scans…
+ SharpHound data collection utilizes the open-source [SharpHound Common](https://github.com/BloodHoundAD/SharpHoundCommon) library, maintained by the BloodHound Enterprise Engineering team, and in BloodHound Enterprise you can start scans…

17-25: Avoid duplicating registry items.
You list DC Registry and CA Registry both in the primary data types list and again at line 104. Consider removing one occurrence to prevent confusion.

Example: Drop them from the top-level list (lines 24–25) since they’re detailed later, or vice versa.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between cbbf6dd and fa30c6e.

📒 Files selected for processing (11)
  • 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)
💤 Files with no reviewable changes (2)
  • docs/collect-data/overview.mdx
  • docs/collect-data/enterprise-collection/overview.mdx
✅ Files skipped from review due to trivial changes (8)
  • docs/collect-data/enterprise-collection/on-demand-scan.mdx
  • docs/get-started/security-boundaries/enterprise-security-overview.mdx
  • docs/install-data-collector/install-sharphound/troubleshooting.mdx
  • docs/install-data-collector/install-sharphound/tenant-configuration.mdx
  • docs/collect-data/enterprise-collection/collection-schedule.mdx
  • docs/install-data-collector/install-sharphound/system-requirements.mdx
  • docs/collect-data/enterprise-collection/ad-hoc-collection.mdx
  • docs/docs.json
🧰 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 (4)
docs/collect-data/permissions.mdx (4)

2-5: Frontmatter update looks good.
The title, sidebarTitle, mode, and description have been correctly generalized to apply to both editions without any missing or inconsistent metadata.


8-8: Pill tag inclusion is appropriate.
The new badge clearly indicates applicability to both Enterprise and Community editions. Alt text is descriptive and the noZoom attribute is valid.


12-14: Enterprise vs. Community scan instructions are clear.
The split between Enterprise (schedule/on-demand) and Community (direct executable) is correctly presented with valid links.


30-32: AD Structure Data description is accurate.
The overview and “This information includes:” heading correctly summarize the section’s contents.

@handplaned handplaned merged commit 630efd7 into SpecterOps:main Jun 18, 2025
2 checks passed
@handplaned handplaned deleted the BHCS-488-add-integration-reference branch June 18, 2025 20:36
@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