Rozdíly

Zde můžete vidět rozdíly mezi vybranou verzí a aktuální verzí dané stránky.

--- informace:jak_psat [2024/01/01 12:47] – page id aither
+++ informace:jak_psat [2026/07/12 20:50] (aktuální) – Doplnění pravidel pro dokumentaci vpsAdminu aither
@@ Řádek 1: / Řádek 1: @@
 <page>information:kb</page>
-====== Jak přispívat do Znalostní Báze ======
+====== Jak přispívat do znalostní báze ======
-Do znalostní báze může pṙispět kterýkoliv člen vpsFree.cz. Pod přihlašovacím formulářem je "Přihlásit se pomocí jiných služeb", tam klikneme na vpsAdmin a následně zadáme přihlašovací údaje do vpsAdminu.
+Do znalostní báze může přispět kterýkoliv člen vpsFree.cz. Pod přihlašovacím formulářem je odkaz „Přihlásit se pomocí jiných služeb“. Klikněte na vpsAdmin a následně zadejte své přihlašovací údaje do vpsAdminu.
 ===== Překlady a prolinkování stránek =====
-Naše KB zatím existuje ve dvou jazykových verzích,
+Naše KB existuje ve dvou jazykových verzích,
 [[https://kb.vpsfree.org|anglické]] a [[https://kb.vpsfree.cz|české]].
 Pro prolinkování stejných stránek v různých jazycích máme vlastní
 [[https://github.com/vpsfreecz/dokuwiki-plugin-mlfarm|plugin]].
-Ten umožnuje stránky označit pomocí tagu ''%%<page>nazev stranky</page>%%''.
+Ten umožňuje stránky označit pomocí tagu ''%%<page>název stránky</page>%%''.
 Stránky se stejným jménem jsou pak navzájem propojeny. Jména stránek se řídí
 podle [[https://kb.vpsfree.org|anglické KB]].
-Například, pokud je v anglické KB stránka
+Například pokud je v anglické KB stránka
 [[https://kb.vpsfree.org/information/association|information:association]] a
 chceme ji propojit s českou stránkou
 [[https://kb.vpsfree.cz/informace/sdruzeni|informace:sdruzeni]], přidáme
-kdekoli do české stránky následující tag:
+kamkoli do české stránky následující tag:
 <code>
@@ Řádek 24: / Řádek 24: @@
 </code>
-Pro přehlednost přidávejte tag prosím vždy na první řádek. Anglická KB se
+Pro přehlednost přidávejte tag vždy na první řádek. Anglická KB se považuje za
-považuje za hlavní, takže tam se tento tag nikde psát nemusí.
+hlavní, takže tam se tento tag nepíše.
 ===== Média =====
 Všechny obrázky a jiné datové soubory jsou sdílené pro obě KB. Jinými slovy,
 nahrajeme-li soubor do jedné KB, objeví se i ve všech ostatních překladech KB.
-Pokud je potřeba mít pro různé jazykové verze jiné média (zejména obrázky),
+Pokud je potřeba mít pro různé jazykové verze různá média (zejména obrázky),
-umístěte je do adresáře pojmenovaného kódem jazyka, tj. např. ''en'', ''cs'', apod.
+umístěte je do adresáře pojmenovaného kódem jazyka, například ''en'' nebo ''cs''.
+===== Dokumentace vpsAdminu =====
+==== Navigace ve vpsAdminu ====
+Každý popis navigace, položky nabídky nebo formuláře ve vpsAdminu musí být
+uzavřen v párovém tagu ''%%<vpsadmin-nav>%%''. Atribut ''id'' obsahuje stabilní
+sémantický identifikátor daného ovládacího prvku. Viditelný text zůstává česky
+a musí odpovídat názvům v aktuálním webovém rozhraní.
+Například:
+<code>
+<vpsadmin-nav id="member.public-keys.add">Upravit profil → Veřejné klíče → Přidat veřejný klíč</vpsadmin-nav>
+</code>
+Identifikátory nevymýšlejte jen v textu KB. Musejí být součástí
+[[https://github.com/vpsfreecz/vpsadmin-kb-captures/blob/master/contract/navigation.yml|navigačního kontraktu]].
+Pokud potřebný identifikátor neexistuje nebo se webové rozhraní mění, postupujte
+podle [[https://github.com/vpsfreecz/vpsadmin-kb-captures/blob/master/docs/webui-change-workflow.md|workflow pro změny webového rozhraní]].
+==== Screenshoty vpsAdminu ====
+Screenshoty vpsAdminu nevytvářejte ani nenahrávejte ručně. Jsou reprodukovatelně
+generovány pomocí Playwright scénářů, vývojového clusteru a připravených dat v
+repozitáři [[https://github.com/vpsfreecz/vpsadmin-kb-captures|vpsadmin-kb-captures]].
+Repozitář spravuje českou i anglickou variantu každého screenshotu. Nový nebo
+změněný screenshot je potřeba upravit a znovu vygenerovat tam, zkontrolovat ve
+staging KB a teprve potom publikovat.
 ===== Maintaineři =====
-Každá stránka může mít přiřazeno jednoho čí více maintainerů. Maintainer je
+Každá stránka může mít přiřazeného jednoho či více maintainerů. Maintainer je
-člověk, který se stará o to, že je obsah na dané stránce aktuální a jsou tam
+člověk, který se stará o aktuálnost a správnost obsahu dané stránky.
-ověřené informace.
-V KB mají maintaineří pouze informační hodnotu, tzn. na koho se obrátit v
+V KB mají maintaineři pouze informační význam: ukazují, na koho se obrátit v
-případě dotazu či nápadu na vylepšení. Drobné změny, opravy či přidávání dalších
+případě dotazu či nápadu na vylepšení. Drobné změny, opravy a další informace
-informací můžete samozřejmě provádět přímo. Pokud sem napíšeš nějaký návod a měl bys
+můžete samozřejmě přidávat přímo. Pokud napíšete návod a máte čas se o něj
-čas se o něj starat, zapiš se u něj prosím jako maintainer.
+starat, zapište se u něj jako maintainer.
 Náš IRC [[informace:chat#bot|bot]] pravidelně kontroluje změny v KB a informuje o
-nich na IRC. Pokud má maintainer v KB vyplněn nick na IRC, bot ho při změně
+nich na IRC. Pokud má maintainer v KB vyplněný nick na IRC, bot ho při změně
-stránky na IRC pingne.
+stránky pingne.
 Na stránce se maintaineři nastavují pomocí tagu ''%%<maintainers>%%'':
@@ Řádek 57: / Řádek 82: @@
 </code>
-První slovo na každém řádku je nick maintainera, z kterého se udělá odkaz na stránku
+První slovo na každém řádku je nick maintainera, ze kterého se vytvoří odkaz na
-''uzivatele:<nick>''. Tu si musí každý maintainer sám vytvořit. Na těchto
+stránku ''uzivatele:<nick>''. Tu si musí každý maintainer vytvořit. Na těchto
-stránkách jsou uloženy profily maintainerů, specifikují se tagem
+stránkách jsou uloženy profily maintainerů, které se zapisují pomocí tagu
 ''%%<maintainer>%%'':
 <code>
-<maintainer name="Moje Jmeno">
+<maintainer name="Moje jméno">
 irc nick_na_irc
 mail nekdo@domena.tld
 </maintainer>
 </code>
-''irc'' i ''mail'' jsou nepovinné.
-Z tohoto profilu si IRC bot vytáhne nick maintainera na IRC a pingne ho při
+Položky ''irc'' a ''mail'' jsou nepovinné. Z tohoto profilu si IRC bot načte
-změně nějaké z jeho stránek.
+nick maintainera na IRC a pingne ho při změně některé z jeho stránek.
 <maintainers hidden>

Znalostní báze

Uživatelské nástroje

Nástroje pro tento web

Rozdíly

Nástroje pro stránku