Skip to content

docs(book,plans): a Conformity Language Reference appendix, and the adminless plan with what shipped - #444

Merged
bmscomp merged 1 commit into
mainfrom
docs/conformity-language-appendix
Oct 21, 2026
Merged

bmscomp merged 1 commit into
mainfrom
docs/conformity-language-appendix

Conversation

@bmscomp

@bmscomp bmscomp commented Oct 21, 2026

Copy link
Copy Markdown
Owner

Why

The Conformity Checks chapter (#431) teaches the KafkaReference language step by step. The book had no single place that lists every field, value kind, rule id, report field and lint code. This adds one as an appendix, after the version matrix, and commits the plan behind #439.

Both files sat uncommitted in the main checkout while ten PRs (#434–#443) landed. Three of those changed what the appendix described, so it's brought up to date with main here.

What changes

docs/book/appendix-conformity-language.md: Conformity Language Reference. It covers:

Aligned with main:

Links to it:

  • _quarto.yml and README.md list it.
  • The Reference part's intro describes it.
  • The CLI Reference's Conformity entry points to it.
  • The chapter's lint paragraph now points to its Lint Findings section, and its Language at a Glance points to the full reference.

11-api-reference.md: the conformity endpoint's 503 now also covers a Kubernetes API that refuses the Kafka resource (#439). Before, it covered only an unreachable one.

plans/adminless-kubernetes.md: the plan behind #439. A status block at the top records:

Tests

Run locally, for the jobs docs/book/** triggers:

  • scripts/check-book-style.sh passes; the structure ratchet holds.
  • scripts/check-book-contrast.py passes.
  • scripts/gen-version-matrix.sh --check and scripts/gen-chart-table.sh --check pass. I ran both in a clean worktree, because this checkout has a leftover, untracked charts/minio directory that only trips them locally.
  • Scratch-copy HTML render (prepare-book-render.sh, quarto render --to html) shows no warnings. check-book-fragments.py passes: all 7,981 fragment links in 40 pages land on an id.
  • A scratch-copy PDF render (--to pdf -M keep-tex:true) builds, with the appendix in it. The only missing glyphs are the six emoji (⏳ ⛔ ✅ ❌ 📊 🔥) this Mac always lacks; the new text adds only …, which the book already uses.
  • No Mermaid in the changed files.

…dminless plan with what shipped

The book teaches the conformity language in its Conformity Checks
chapter, but had no place that lists every field, value kind, rule id,
report field and lint code. A new appendix does, after the version
matrix; the chapter, the CLI Reference, the Reference part's intro and
the README point to it.

It is written against main as of #443:
- a key set twice to the same value is a lint error that fmt fixes (#437);
- with rbac.scope=namespace, zones, skew and rack awareness read the
  EndpointSlices of the brokers' headless Service when nodes can't be
  listed, and podMonitor looks in the Kafka namespace only (#439);
- a refused get of the Kafka resource is a 503 naming the grant (#439),
  which the API Reference now says too;
- the chart sets the checked namespace and cluster from
  networkPolicy.kafka.namespace and kafka.clusterName (#441).

plans/adminless-kubernetes.md is the plan behind #439, with a status
block naming what shipped in #439 and #441-#443, where the work departed
from it (EndpointSlice zones; orphan recovery left on), and what is
still open.
@bmscomp
bmscomp merged commit c788bf2 into main Oct 21, 2026
55 checks passed
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