BED-8189: Update default admin email

[jeff-matthews]

Minor doc updates for next release related to BED-8189:

• Update the default admin email address in the shared snippet
• Update example config with default admin email and remove deprecated field

Summary by CodeRabbit

• Documentation
  • Updated default admin configuration example to include email_address field
  • Corrected default admin email address in sample data documentation from placeholder to standard admin email

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d1b51ea8-f283-4474-bee6-efefae1dc274

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

Walkthrough

Two documentation snippets are updated to align the default admin email configuration: the default_admin example JSON now shows email_address instead of principal_name, and the sample data email is changed from spam@example.com to admin@example.com across both files.

Changes

Default admin email configuration

Layer / File(s)	Summary
Default admin email configuration examples docs/manage-bloodhound/bh-config.mdx, docs/snippets/sample-data.mdx	The default_admin example JSON adds email_address and removes principal_name. The sample data documentation email is updated to admin@example.com for consistency.

🎯 1 (Trivial) | ⏱️ ~2 minutes

🐰 Two tiny docs align their admin email cheer,
From spam to admin, the path becomes clear!
No logic to test, just examples bright,
Configuration docs now look just right! ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: updating the default admin email address across documentation files.
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.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch BED-8189-admin-email

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[jeff-matthews]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

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.

[cami-specter]

Was there a reason principal_name was removed? It gets filled by default if missing, but it's an essential field and would probably be good to show in the example JSON configuration.

[jeff-matthews]

@cami-specter, I thought I should remove it from the example because the docs above indicate that it is deprecated. Maybe that's a mistake though.

[cami-specter]

Oh, I see. It's definitely not deprecated in the code and in our build.config.json.template which we use to set local configs (https://github.com/SpecterOps/BloodHound/blob/main/local-harnesses/build.config.json.template#L19), but there might be context I'm not aware of. Probably best to remove it then if it's marked as such!

[jeff-matthews]

I'll see if I can find out more about why that was marked as deprecated in docs only.

[jeff-matthews]

I'm going to revert this change to align with the codebase.