Docs pages generated from the chart: values, ports and policies, alerts (K-D2) #30

Merged
jcoffey-dev merged 3 commits from feat/docs-pages into main 2026-11-20 03:30:21 +00:00
Owner

K-D2, chart side. tools/docs-pages.py --out <dir> writes the docs' generated Kubernetes pages, the way inbuxa-admin's build-manual.mjs writes the settings reference:

  • values.md: every value, its default, type and limits, with its comment (same entries as VALUES.md).
  • ports.md: each Service, its type, the Deployments it sends to and its ports; what each NetworkPolicy lets in and out.
  • alerts.md: each alert, severity, wait, when it fires and what to do (Prometheus templating turned into words).

Rendered with the new ci/docs-values.yaml (defaults plus webmail, console, metrics, backups on). check.sh builds them, so a template change that breaks one fails CI (the job gets python3-yaml). VALUES.md now puts default, limits and comment on separate lines.

Tested: tools/check.sh; pages built into the docs PR and looked at in a browser.

K-D2, chart side. `tools/docs-pages.py --out <dir>` writes the docs' generated Kubernetes pages, the way inbuxa-admin's build-manual.mjs writes the settings reference: - `values.md`: every value, its default, type and limits, with its comment (same entries as VALUES.md). - `ports.md`: each Service, its type, the Deployments it sends to and its ports; what each NetworkPolicy lets in and out. - `alerts.md`: each alert, severity, wait, when it fires and what to do (Prometheus templating turned into words). Rendered with the new `ci/docs-values.yaml` (defaults plus webmail, console, metrics, backups on). `check.sh` builds them, so a template change that breaks one fails CI (the job gets python3-yaml). VALUES.md now puts default, limits and comment on separate lines. **Tested**: `tools/check.sh`; pages built into the docs PR and looked at in a browser.
jcoffey-dev added 3 commits 2026-11-19 21:25:59 +00:00
tools/docs-pages.py writes the generated pages of the docs' Kubernetes
section into a folder (the docs repo's content/docs/kubernetes), the way
inbuxa-admin's build-manual.mjs writes the settings reference:

- values.md: every value, from values.yaml and the schema (the same
  entries as VALUES.md; values-reference.py now exposes them as body()).
- ports.md: each Service, its type, the Deployments it sends to and its
  ports, and what each NetworkPolicy lets in and out.
- alerts.md: each alert rule, its severity, its wait, when it fires and
  what to do, with Prometheus' templating turned into words.

Rendered with ci/docs-values.yaml: the defaults with webmail, console,
metrics and backups on, so every part shows. check.sh builds them (CI
gets python3-yaml for that); ci/ also puts the file through every other
check.
jcoffey-dev merged commit 0da61b103e into main 2026-11-20 03:30:21 +00:00
jcoffey-dev deleted branch feat/docs-pages 2026-11-20 03:30:22 +00:00
Sign in to join this conversation.