Uživatelské nástroje

Nástroje pro tento web


informace:jak_psat

Rozdíly

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

Odkaz na výstup diff

Obě strany předchozí revizePředchozí verze
Následující verze
Předchozí verze
informace:jak_psat [2026/07/12 20:50] – Doplnění pravidel pro dokumentaci vpsAdminu aitherinformace:jak_psat [2026/08/13 06:49] (aktuální) – Doplnění KVM navigace a pravidel dokumentace vpsAdminu aither
Řádek 35: Řádek 35:
 ===== Dokumentace vpsAdminu ===== ===== Dokumentace vpsAdminu =====
 ==== Navigace ve vpsAdminu ==== ==== Navigace ve vpsAdminu ====
-Každý popis navigace, položky nabídky nebo formuláře ve vpsAdminu musí být +Každý pokyn k provedení akce ve vpsAdminu i každý popis navigace, položky 
-uzavřen v párovém tagu ''%%<vpsadmin-nav>%%''. Atribut ''id'' obsahuje stabilní+nabídky nebo formuláře musí být uzavřen v párovém tagu 
 +''%%<vpsadmin-nav>%%''. Platí to i pro pokyn, který pouze říká změnit nastavení 
 +a výslovně nezmiňuje nabídku ani formulář. Atribut ''id'' obsahuje stabilní
 sémantický identifikátor daného ovládacího prvku. Viditelný text zůstává česky 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í. a musí odpovídat názvům v aktuálním webovém rozhraní.
Řádek 47: Řádek 49:
  
 Identifikátory nevymýšlejte jen v textu KB. Musejí být součástí 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]].+[[https://github.com/vpsfreecz/vpsfree-kb-contracts/blob/master/contract/navigation.yml|navigačního kontraktu]].
 Pokud potřebný identifikátor neexistuje nebo se webové rozhraní mění, postupujte 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í]].+podle [[https://github.com/vpsfreecz/vpsfree-kb-contracts/blob/master/docs/webui-change-workflow.md|workflow pro změny webového rozhraní]].
  
 ==== Screenshoty vpsAdminu ==== ==== Screenshoty vpsAdminu ====
 Screenshoty vpsAdminu nevytvářejte ani nenahrávejte ručně. Jsou reprodukovatelně 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 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áři [[https://github.com/vpsfreecz/vpsfree-kb-contracts|vpsfree-kb-contracts]].
 Repozitář spravuje českou i anglickou variantu každého screenshotu. Nový nebo 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 změněný screenshot je potřeba upravit a znovu vygenerovat tam, zkontrolovat ve
 staging KB a teprve potom publikovat. staging KB a teprve potom publikovat.
 +
 +==== Články spravované v repozitáři ====
 +Některé články jsou společně se svými automatickými testy spravovány v
 +repozitáři ''vpsfree-kb-contracts''. Poznáte je podle odkazu **Zdroj na
 +GitHubu** v panelu nástrojů stránky. Editor KB navíc zobrazí upozornění s
 +odkazy na zdrojový text, automatický test a návod **Jak přispívat do
 +znalostní báze**. Ruční úpravy takového článku přímo v KB jsou možné, ale
 +automatický test je neověří. Ověřenou změnu je proto potřeba provést také v
 +odkazovaném repozitáři.
 +
 +Pokud už byl spravovaný článek změněn přímo v KB, upozorněte správce. Příprava
 +dalšího vydání změnu odmítne přepsat, dokud ji správce nepřevezme nebo nesloučí
 +do zdrojového textu a znovu neověří.
  
 ===== Maintaineři ===== ===== Maintaineři =====
Řádek 65: Řádek 80:
 V KB mají maintaineři pouze informační význam: ukazují, 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 a další informace případě dotazu či nápadu na vylepšení. Drobné změny, opravy a další informace
-můžete samozřejmě přidávat přímo. Pokud napíšete návod a máte čas se o něj+můžete přidávat přímo. U článků spravovaných v repozitáři nejsou ruční změny 
 +ověřovány jejich automatickými testy. Pokud napíšete návod a máte čas se o něj
 starat, zapište se u něj jako maintainer. starat, zapište se u něj jako maintainer.
  
informace/jak_psat.1783889449.txt.gz · Poslední úprava: autor: aither