Skip to content

chore: scrub internal network identifiers - #11

Merged
jmagar merged 2 commits into
mainfrom
chore/scrub-internal-identifiers-20260805
Sep 13, 2026
Merged

jmagar merged 2 commits into
mainfrom
chore/scrub-internal-identifiers-20260805

Conversation

@jmagar

@jmagar jmagar commented Aug 5, 2026

Copy link
Copy Markdown
Collaborator

Summary

Tracked examples and documentation now use neutral, reserved identifiers instead of internal network names, addresses, domains, and host aliases. The scrub keeps configuration examples useful while preventing repository content from encoding a specific private environment.

Why This Exists

Internal infrastructure identifiers had accumulated across plugin metadata, skills, documentation, and the homelab report generator. Those values were unnecessary for users and made otherwise reusable guidance specific to one environment.

Resolution

  • replaces private LAN examples with RFC 5737 documentation addresses
  • replaces overlay-network and internal DNS values with reserved example domains
  • replaces host aliases with role-based neutral names
  • updates the homelab report generator and its outputs consistently
  • preserves the existing configuration keys and behavior

Reviewer Considerations

The primary review concern is completeness and consistency: every replacement should remain syntactically valid for its surrounding configuration while avoiding real internal identifiers. No runtime behavior is intended to change.

Behavior Changes

None. Documentation, defaults, examples, and generated report labels now use neutral placeholders.

Verification

  • rebased onto current main without conflicts
  • plugins/scripts/check-all passed
  • plugin schema validation passed
  • 46 plugin tests passed
  • 11 artifact tests passed
  • marketplace manifests aligned at 78 Claude and 78 Codex entries
  • plugin documentation check passed
  • git diff --check origin/main...HEAD passed

Risk

Low. The changes are identifier substitutions across documentation, metadata, scripts, and generated content; repository validation covers schema and marketplace consistency.

@jmagar

jmagar commented Aug 5, 2026

Copy link
Copy Markdown
Collaborator Author

Verified all reviewer findings from the identifier-scrub review are resolved on this branch (already addressed in an earlier commit on the branch):

  • Renamed the leftover local variables in the homelab report generator to the neutral role-based placeholders used elsewhere in this PR.
  • Re-ran the completeness sweep; no remaining occurrences outside the documented allowed exceptions.

No functional changes.

Skill Test added 2 commits September 13, 2026 14:28
Replace private homelab identifiers that leaked into this public repo
with generic, non-identifying placeholders:

- Private LAN addresses -> 192.0.2.0/24 (RFC 5737 documentation range),
  keeping the last octet stable so distinct hosts stay distinguishable.
- Overlay/mesh addresses -> 198.51.100.0/24, with a stable per-address
  mapping so repeated references still point at the same placeholder.
- The private mesh domain suffix -> example.ts.net, and the bare mesh
  network name -> a generic placeholder.
- Personal host aliases -> role-based placeholder names (NAS, dev host,
  edge host, backup host, Windows host, laptop host, etc.), renamed
  consistently everywhere they appear (docs, plugin manifests, script
  defaults, data structures) so nothing is left inconsistent.
- Personal subdomains of a private domain -> a generic internal
  placeholder domain; the one already-public registry subdomain was
  left untouched since it must keep resolving.

Sanity check: ran this repo's own plugins/scripts/check-all (JSON
schema validation + full Python test suite + marketplace/doc
consistency checks) both before and after the edits; identical test
counts, identical pre-existing warnings, exit 0 both times.
Rename leftover tootie_df/tootie_parity locals to nashost_df/nashost_parity
to match the renamed snapshots["nashost"] key, use the *.example.internal
placeholder consistently for the public domain field instead of coining
*.nashost.tv, and fix the ASCII diagram alignment in screenshots/README.md
after the winhost-wsl placeholder rename.
@jmagar
jmagar force-pushed the chore/scrub-internal-identifiers-20260805 branch from fbfa4e1 to ac6a068 Compare September 13, 2026 18:33
@jmagar
jmagar merged commit e597564 into main Sep 13, 2026
10 checks passed
@jmagar
jmagar deleted the chore/scrub-internal-identifiers-20260805 branch September 13, 2026 18:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant