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.

Naše KB existuje ve dvou jazykových verzích, anglické a české. Pro prolinkování stejných stránek v různých jazycích máme vlastní plugin. 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 anglické KB.

Například pokud je v anglické KB stránka information:association a chceme ji propojit s českou stránkou informace:sdruzeni, přidáme kamkoli do české stránky následující tag:

<page>information:association</page>

... text stránky ...

Pro přehlednost přidávejte tag vždy na první řádek. Anglická KB se považuje za hlavní, takže tam se tento tag nepíše.

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 různá média (zejména obrázky), umístěte je do adresáře pojmenovaného kódem jazyka, například en nebo cs.

Každý pokyn k provedení akce ve vpsAdminu i každý popis navigace, položky 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 a musí odpovídat názvům v aktuálním webovém rozhraní.

Například:

<vpsadmin-nav id="member.public-keys.add">Upravit profil → Veřejné klíče → Přidat veřejný klíč</vpsadmin-nav>

Identifikátory nevymýšlejte jen v textu KB. Musejí být součástí navigačního kontraktu. Pokud potřebný identifikátor neexistuje nebo se webové rozhraní mění, postupujte podle workflow pro změny webového rozhraní.

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 vpsfree-kb-contracts. 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.

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ěří.

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 aktuálnost a správnost obsahu dané stránky.

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 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.

Náš IRC 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ě stránky pingne.

Na stránce se maintaineři nastavují pomocí tagu <maintainers>:

<maintainers>
aither
nick2 (prvni sekce)
nick3 (druha sekce)
</maintainers>

První slovo na každém řádku je nick maintainera, ze kterého se vytvoří odkaz na stránku uzivatele:<nick>. Tu si musí každý maintainer vytvořit. Na těchto stránkách jsou uloženy profily maintainerů, které se zapisují pomocí tagu <maintainer>:

<maintainer name="Moje jméno">
irc nick_na_irc
mail nekdo@domena.tld
</maintainer>

Položky irc a mail jsou nepovinné. Z tohoto profilu si IRC bot načte nick maintainera na IRC a pingne ho při změně některé z jeho stránek.

• aither
• krcmar
• kerrycze