Skip to content

DOCS-11: Minor copyedit#352

Open
jeff-matthews wants to merge 2 commits into
mainfrom
DOCS-11-copyedit
Open

DOCS-11: Minor copyedit#352
jeff-matthews wants to merge 2 commits into
mainfrom
DOCS-11-copyedit

Conversation

@jeff-matthews

@jeff-matthews jeff-matthews commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Clarify prerequisites for SharpHound Enterprise installation.

Summary by CodeRabbit

  • Documentation
    • Updated the SharpHound Enterprise installation and upgrade prerequisites.
    • Clarified the required sign-in authorization and retained a reference to user role definitions.

@jeff-matthews jeff-matthews self-assigned this Jul 16, 2026
@jeff-matthews jeff-matthews added feedback Updates based on internal and external feedback data-collection Docs related to nodes, edges, and general data collection labels Jul 16, 2026
@coderabbitai

coderabbitai Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@jeff-matthews, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 54 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: cb6fe78b-aab8-4082-a64b-5dbcdb4b6f6a

📥 Commits

Reviewing files that changed from the base of the PR and between 29a6c5a and 1324c82.

📒 Files selected for processing (1)
  • docs/install-data-collector/install-sharphound/installation-upgrade.mdx

Walkthrough

The SharpHound Enterprise installation and upgrade guide updates its “Before you begin” prerequisite to include authorized user-role sign-in guidance and a link to User Role Definitions.

Changes

SharpHound installation documentation

Layer / File(s) Summary
Update sign-in prerequisite
docs/install-data-collector/install-sharphound/installation-upgrade.mdx
The prerequisite bullet now includes authorized user-role sign-in guidance and links to the User Role Definitions documentation.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

Poem

A bunny found a role to sign,
And linked the guide in perfect line.
The install path now hops with care,
With clearer steps for those who dare.
Thump, thump! The docs are fine.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title is relevant to a docs change, but "Minor copyedit" is too vague to describe the prerequisite clarification made here. Rename it to reflect the actual change, such as clarifying SharpHound Enterprise installation prerequisites or the "Before you begin" section.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch DOCS-11-copyedit

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

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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/install-data-collector/install-sharphound/installation-upgrade.mdx`:
- Line 13: Update the installation prerequisite text around the SharpHound
Enterprise role statement to limit the BloodHound role’s authorization to
downloading installation binaries. Add a separate statement that running the
installer requires appropriate local Windows permissions, consistent with the
existing administrator requirement later in the document.
🪄 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: 97758b2e-face-41ce-93b7-787a3fbf8679

📥 Commits

Reviewing files that changed from the base of the PR and between 20b691a and 29a6c5a.

📒 Files selected for processing (1)
  • docs/install-data-collector/install-sharphound/installation-upgrade.mdx


- Deploy a domain-joined Windows server for the service. For requirements and deployment guidance, see [SharpHound Enterprise System Requirements and Deployment Process](/install-data-collector/install-sharphound/system-requirements).
- Sign in with a user role that is authorized to download SharpHound Enterprise installation binaries. For role details, see [User Role Definitions](/manage-bloodhound/auth/users-and-roles#user-role-definitions).
- Sign in with a user role that is authorized to download and run SharpHound Enterprise installation binaries. For role details, see [User Role Definitions](/manage-bloodhound/auth/users-and-roles#user-role-definitions).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Do not imply that the BloodHound role grants local execution rights.

The linked role definitions document authorizes downloading collector packages; executing the installer is governed by local Windows permissions, as reflected by the later administrator requirement at Line 49. Scope the role clause to downloading and state the local execution requirement separately.

Suggested wording
-- Sign in with a user role that is authorized to download and run SharpHound Enterprise installation binaries. For role details, see [User Role Definitions](/manage-bloodhound/auth/users-and-roles#user-role-definitions).
+- Sign in with a user role that is authorized to download SharpHound Enterprise installation binaries. For role details, see [User Role Definitions](/manage-bloodhound/auth/users-and-roles#user-role-definitions).
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- Sign in with a user role that is authorized to download and run SharpHound Enterprise installation binaries. For role details, see [User Role Definitions](/manage-bloodhound/auth/users-and-roles#user-role-definitions).
- Sign in with a user role that is authorized to download SharpHound Enterprise installation binaries. For role details, see [User Role Definitions](/manage-bloodhound/auth/users-and-roles#user-role-definitions).
🤖 Prompt for 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.

In `@docs/install-data-collector/install-sharphound/installation-upgrade.mdx` at
line 13, Update the installation prerequisite text around the SharpHound
Enterprise role statement to limit the BloodHound role’s authorization to
downloading installation binaries. Add a separate statement that running the
installer requires appropriate local Windows permissions, consistent with the
existing administrator requirement later in the document.

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

Labels

data-collection Docs related to nodes, edges, and general data collection feedback Updates based on internal and external feedback

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants