Differences

This shows you the differences between two versions of the page.

--- information:kb [2026/07/12 20:51] – Expand the contribution guide and document the vpsAdmin workflow aither
+++ information:kb [2026/08/13 06:49] (current) – Add KVM navigation coverage and vpsAdmin documentation rules aither
@@ Line 35: / Line 35: @@
 ===== Documenting vpsAdmin =====
 ==== Navigation in vpsAdmin ====
-Every description of navigation, a menu entry, or a form in vpsAdmin must be
+Every instruction to perform an action in vpsAdmin, as well as every
-wrapped in a paired ''%%<vpsadmin-nav>%%'' tag. Its ''id'' attribute contains
+description of navigation, a menu entry, or a form, must be wrapped in a paired
-the stable semantic identifier of that control. The visible text remains in
+''%%<vpsadmin-nav>%%'' tag. This also applies when an instruction only says to
-English and must match the current WebUI labels.
+change a setting without explicitly naming a menu or form. Its ''id'' attribute
+contains the stable semantic identifier of that control. The visible text
+remains in English and must match the current WebUI labels.
 For example:
@@ Line 47: / Line 49: @@
 Do not invent identifiers only in KB text. They must be part of the
-[[https://github.com/vpsfreecz/vpsadmin-kb-captures/blob/master/contract/navigation.yml|navigation contract]].
+[[https://github.com/vpsfreecz/vpsfree-kb-contracts/blob/master/contract/navigation.yml|navigation contract]].
 If the required identifier does not exist, or the WebUI is changing, follow the
-[[https://github.com/vpsfreecz/vpsadmin-kb-captures/blob/master/docs/webui-change-workflow.md|WebUI change documentation workflow]].
+[[https://github.com/vpsfreecz/vpsfree-kb-contracts/blob/master/docs/webui-change-workflow.md|WebUI change documentation workflow]].
 ==== vpsAdmin screenshots ====
@@ Line 55: / Line 57: @@
 reproducibly using Playwright scenarios, a development cluster, and prepared
 fixtures in
-[[https://github.com/vpsfreecz/vpsadmin-kb-captures|vpsadmin-kb-captures]].
+[[https://github.com/vpsfreecz/vpsfree-kb-contracts|vpsfree-kb-contracts]].
 The repository maintains both Czech and English variants of every screenshot.
 Add or update a screenshot there, regenerate it, review it on the staging KB,
 and only then publish it.
+==== Repository-managed articles ====
+Some articles and their automated tests are maintained in the
+''vpsfree-kb-contracts'' repository. They have a **Source on GitHub** entry in
+the page toolbar. The KB editor also displays a notice with links to the
+source text, automated test, and **Contributing to the Knowledge Base**
+guide. Manual edits to such an article in the KB are possible, but the
+automated test does not verify them. To make a verified change, update the
+linked repository as well.
+If a managed article has already been edited directly in the KB, notify its
+maintainers. The next release will refuse to overwrite the edit until it is
+adopted or merged into the source text and verified again.
 ===== Maintainers =====
@@ Line 65: / Line 80: @@
 Maintainers are informational: they show whom to contact with a question or an
-idea for improvement. Anyone can still make small changes, corrections, or add
+idea for improvement. Pages can still be edited directly. Manual changes to
-more information directly. If you write a guide and have time to maintain it,
+repository-managed pages are not verified by their automated tests. If you
-please add yourself as a maintainer.
+write a guide and have time to maintain it, please add yourself as a
+maintainer.
 Our IRC [[information:chat#bot|bot]] regularly checks KB changes and announces

Knowledge base

User Tools

Site Tools

Differences

Page Tools