Skip to content

docs(crds): 📝 add generated+augmented ChannelAuthRule reference page (DOC-7)#94

Merged
konih merged 1 commit into
mainfrom
worktree-doc7-channelauthrule
Jul 10, 2026
Merged

docs(crds): 📝 add generated+augmented ChannelAuthRule reference page (DOC-7)#94
konih merged 1 commit into
mainfrom
worktree-doc7-channelauthrule

Conversation

@konih

@konih konih commented Jul 10, 2026

Copy link
Copy Markdown
Collaborator

DOC-7 — ChannelAuthRule (car) per-kind CRD reference page

Fourth per-kind CRD reference page, following the Queue (#91), Topic (#92), and Channel (#93) pilots. Docs-only, no Go/CRD-schema changes.

Scope

  • docs/crds/channelauthrule.md — hand-authored intro, Rule types table (ADDRESSMAP/USERMAP/QMGRMAP/SSLPEERMAP/BLOCKUSER/BLOCKADDR), ADDRESSMAP + USERMAP examples, SET CHLAUTH MQSC-mapping prose; generated field table between <!-- crd-ref:begin ChannelAuthRule --> / end markers (via task docs:crd-ref).
  • mkdocs.yml — Reference nav entry "ChannelAuthRule (car)".
  • docs/crds/README.md — link in the kinds table + "Available so far" line.

Gates

  • task lint:markdown — 0 errors (84 files)
  • task docs:crd-ref — idempotent; drift gate clean (no change to existing generated pages)
  • All relative links / anchor / sample YAML targets verified to exist
  • Employer/prod string scrub clean

Notes

  • Auth kinds expose typed fields only (no free-form spec.attributes), reflected in the page prose.
  • docs(crds): is excluded from the changelog by git-cliff (ADR-0008) — deliberate.

DOC-7 remaining after this: AuthorityRecord, QueueManagerConnection.

@konih
konih merged commit fbabd48 into main Jul 10, 2026
14 checks passed
@konih
konih deleted the worktree-doc7-channelauthrule branch July 11, 2026 07:40
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