Skip to content

2.23.0: documentation site in English and Turkish

Choose a tag to compare

@vurulkan vurulkan released this 14 Nov 20:06
· 5 commits to main since this release

What's new

Documentation site, in English and Turkish: https://k8sopenconsole.github.io/ (Türkçe)

  • The manual moved from the README to its own site: getting started, installation, user guide, administration, API and agents, operations (logging, Elastic, metrics and alerts, tracing, security model, hardening, air-gapped, troubleshooting) and release notes. Every command on it was run on a real cluster.
  • Every page in Turkish, in the words of the app's Turkish UI. Switching the language keeps you on the same page and section.
  • Reference pages generated from the code, so they can't drift: environment variables, application permissions, Kubernetes permissions (ClusterRole rule by rule), audit events, metrics, keyboard shortcuts, and one page per API endpoint from the OpenAPI description.
  • Versioned per minor release from 2.23 on.

In the app

  • The sign-in page footer reads Kubernetes OpenConsole · GitHub | Docs; a book icon in the nav rail (above GitHub) opens the docs. Both open the site in the UI's language.
  • The keyboard cheat sheet (?) lists the Saved Views keys (arrows, Enter, 1–9, Esc) and Esc to clear a table selection.

For contributors

  • backend/cmd/docgen writes the reference pages (English and Turkish) from the registries next to the code (config.Vars, rbac.ActionDocs, audit.*Docs, api.Metrics, the comments in deploy/rbac*.yaml, frontend/src/shortcuts.json); CI fails when they are out of date.
  • The README is now a short front door; CLAUDE.md asks every app change to update the docs in both languages.

Upgrading

  • No change to the server, the API, the database or the ClusterRole: replace the image. Rolling back to 2.22.0 works.
  • Bookmarks into the old README: the same sections are on the site; 2.22.0's README stays at the v2.22.0 tag.

Tested: the image on Docker (probes, first sign-in and password change, the docs links in English and Turkish) and on a k3d cluster installed with the docs' kustomize steps (?ref=v2.23.0).

Image

ghcr.io/vurulkan/kubernetes-openconsole:2.23.0 (= :latest, same digest sha256:f4877e65…; amd64 + arm64), with signed provenance and SBOM:
gh attestation verify oci://ghcr.io/vurulkan/kubernetes-openconsole:2.23.0 --repo vurulkan/kubernetes-openconsole

🤖 Generated with Claude Code