Skip to content

DOCS-27: Collector support bundles - #381

Draft
jeff-matthews wants to merge 12 commits into
mainfrom
DOCS-27-collector-support-bundles
Draft

DOCS-27: Collector support bundles#381
jeff-matthews wants to merge 12 commits into
mainfrom
DOCS-27-collector-support-bundles

Conversation

@jeff-matthews

@jeff-matthews jeff-matthews commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Summary

This pull request (PR) adds net new docs describing the collector bundle support feature associated with the BED-7970 epic.

Staging

We no longer have access to staging builds on Mintlify 😒

But you can build the site locally to preview the changes.

Summary by CodeRabbit

  • Documentation
    • Added guidance for managing SharpHound Enterprise collector support bundles, including prerequisites, permissions, lifecycle, downloads, deletion, contents, data handling, and troubleshooting.
    • Added collector support bundles to the enterprise collection navigation and overview.
    • Documented the administrator-only permission to request, download, and delete support bundles.
    • Added a glossary definition for collector support bundles.

@jeff-matthews jeff-matthews self-assigned this Aug 10, 2026
@jeff-matthews jeff-matthews added administration Docs related to managing general tenant configuration v9.6.0 labels Aug 10, 2026
@coderabbitai

coderabbitai Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

This change adds BloodHound Enterprise documentation for SharpHound Enterprise collector support bundles. It covers access, lifecycle, requests, downloads, deletion, troubleshooting, navigation, permissions, and glossary terminology.

Changes

Collector support bundles

Layer / File(s) Summary
Access and terminology
docs/collect-data/enterprise-collection/collector-support-bundles.mdx, docs/manage-bloodhound/auth/users-and-roles.mdx, docs/resources/glossary/overview.mdx
Documents prerequisites, Administrator-only permissions, and collector support bundle terminology.
Bundle lifecycle and operations
docs/collect-data/enterprise-collection/collector-support-bundles.mdx
Documents bundle states, retention, requesting, downloading, deletion, contents, warnings, and troubleshooting.
Collection navigation
docs/collect-data/enterprise-collection/overview.mdx, docs/docs.json
Adds descriptions and navigation entries for the collector support bundle documentation.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Suggested labels: data-collection

Suggested reviewers: slokie-so

Poem

I’m a rabbit with bundles to share,
ZIP files tucked with careful care.
Admin paws request and delete,
Logs and settings rest neat and complete.
Ninety days, then they disappear—
Clear docs make the path quite clear.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely identifies the main documentation change: collector support bundles.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch DOCS-27-collector-support-bundles

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

@jeff-matthews

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@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/collect-data/enterprise-collection/collector-support-bundles.mdx`:
- Line 35: Remove the ETAC environment-access prerequisite from the
support-bundle requirements, including the corresponding environment-access
requirement at the second referenced location. Leave the remaining client and
role prerequisites unchanged.
🪄 Autofix

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: 5b6c557b-31f7-4d64-a613-af7a53c7aaa5

📥 Commits

Reviewing files that changed from the base of the PR and between 76cd167 and 56426ff.

📒 Files selected for processing (5)
  • docs/collect-data/enterprise-collection/collector-support-bundles.mdx
  • docs/collect-data/enterprise-collection/overview.mdx
  • docs/docs.json
  • docs/manage-bloodhound/auth/users-and-roles.mdx
  • docs/resources/glossary/overview.mdx

Comment thread docs/collect-data/enterprise-collection/collector-support-bundles.mdx Outdated

@bfaulk96 bfaulk96 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

One small comment, but looks good and thorough

@jeff-matthews

Copy link
Copy Markdown
Contributor Author

@slokie-so, tech review complete. Will only merge if you approve.

@jeff-matthews
jeff-matthews marked this pull request as draft August 11, 2026 20:37
@jeff-matthews

Copy link
Copy Markdown
Contributor Author

We're not releasing the feature yet.

Converted to draft and removed from v9.6.0 doc deliverables.

Base automatically changed from release/v9.6.0 to main August 18, 2026 20:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

administration Docs related to managing general tenant configuration

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants