Skip to content

docs: rework the module documentation - #79

Open
drey wants to merge 6 commits into
feat/ns-scoped-applicationsfrom
docs/rework
Open

drey wants to merge 6 commits into
feat/ns-scoped-applicationsfrom
docs/rework

Conversation

@drey

@drey drey commented Sep 23, 2026

Copy link
Copy Markdown
Collaborator

Reworks the module documentation and brings the English side back in step with the Russian.

What changed

  • EXAMPLE.ru.md is split into a guide per audience: ADMIN_GUIDE.ru.md for the cluster-scoped resources and USER_GUIDE.ru.md for the namespaced ones. README.ru.md gains a mermaid diagram of the resource model, links to every CRD it names, and a limitations section.
  • Both guides and the overview are translated into English. EXAMPLE.md went away with the split, so the English side had lost its examples page and kept a dangling link to it; ADMIN_GUIDE.md, USER_GUIDE.md and the rewritten README.md replace it.
  • The product is called Deckhouse Platform, not Deckhouse Kubernetes Platform.
  • Release notes: four typos fixed and the Russian v0.1.0 entries moved out of the imperative, in CHANGELOG/ so the fix survives generation. Bullets are capitalized in the generated pages only — chlog.py emits the changelog strings verbatim, so that half does not survive the next run until the generator capitalizes them itself.
  • The status tables pick up the renamed RBAC condition reasons that this PR's base introduces.

Notes for the reviewer

  • The web-interface labels in the English guides are translated literally. The console strings in the checkout do not match the UI the Russian text describes, so they could not be checked against it — worth a second pair of eyes.
  • ADMIN_GUIDE.ru.md:203-204 navigates "Проекты" → "Репозитории" for a cluster-scoped repository, where the rest of the file uses "Система" → "Репозитории аддонов". Left as is; the actual console path could not be verified here.
  • The overview's mermaid block parses under mermaid 11.9.0, the version pinned on the docs site. Every documentation link was resolved against the rendered CRD reference page.
  • docs/superpowers/ still carries the pre-rename names. Those are dated design records, so they were left alone.

🤖 Generated with Claude Code

The examples page mixed cluster-wide and namespaced scenarios, so neither
audience could read it straight through. It is replaced by a guide per role:
ADMIN_GUIDE.ru.md for the cluster-scoped kinds and USER_GUIDE.ru.md for the
namespaced ones, each with tabbed CLI and web-interface instructions and a
table of the statuses its resources can report. README.ru.md gains a diagram
of the resource model and links every kind to its reference page.

The English side is untouched, so the pair is diverged: EXAMPLE.md is gone
while README.md still links to example.html, and no English guides exist yet.

Signed-off-by: Ilya Drey <ilya.drey@flant.com>
The English side had fallen behind: EXAMPLE.md was deleted with the Russian
rework while README.md still linked to example.html, and neither guide existed.
Both guides and the overview are now translated from their Russian originals,
so the two languages carry the same structure, diagram and status tables.

The web-interface labels are translated literally: the console strings in the
checkout do not match the UI the Russian text describes, so they could not be
verified against it.

Signed-off-by: Ilya Drey <ilya.drey@flant.com>
Four mentions inside the resource lists were left as bare code spans while the
first mention of each kind was already a link.

Signed-off-by: Ilya Drey <ilya.drey@flant.com>
Deckhouse Kubernetes Platform is not the name the product goes by.

Signed-off-by: Ilya Drey <ilya.drey@flant.com>
Fix four typos and the Russian entries of v0.1.0, which were the only ones left
in the imperative; the wording lives in CHANGELOG, so it is fixed there too.

Capitalizing the bullets is applied to the generated pages alone: chlog.py
emits the changelog strings as they are, so the change does not survive the
next run until the generator itself capitalizes them.

Signed-off-by: Ilya Drey <ilya.drey@flant.com>
The reasons a release reports for its identity are now RBACSetupFailed and
ForeignRBACObject. The code change is on feat/ns-scoped-applications; the
guides these rows live in exist only on this branch, so the two halves cannot
share a commit.

Signed-off-by: Ilya Drey <ilya.drey@flant.com>
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