Rozdíly

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

--- informace:jak_psat [2014/11/25 12:41] – admin
+++ informace:jak_psat [2026/08/13 06:49] (aktuální) – Doplnění KVM navigace a pravidel dokumentace vpsAdminu aither
@@ Řádek 1: / Řádek 1: @@
-====== Jak přispívat do Znalostní Báze ======
+<page>information:kb</page>
-Jako všechno na vpsFree, i KB bude fungovat pouze pokud se zapojí komunita. Vše by ovšem mělo mít svůj řád a pořádek, shrneme si tedy nějaké základní pravidla, která by se měla dodržovat při přispívání.
+====== 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 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řečtěte si stránku o [[wiki:syntax|syntaxi]]**
+===== Překlady a prolinkování stránek =====
-  - dodržovat [[https://www.dokuwiki.org/cs:namespaces|Jmenné prostory]]  (Jmenné prostory(sekce) jsou vidět v navigaci.)
+Naše KB existuje ve dvou jazykových verzích,
-  - Řídit se referenční stránkou o [[navody:server:SSH]] (Později bude dostupná i šablona)
+[[https://kb.vpsfree.org|anglické]] a [[https://kb.vpsfree.cz|české]].
-  - psát jako člověk, tedy s diakritikou a bez pravopisných chyb
+Pro prolinkování stejných stránek v různých jazycích máme vlastní
-  - správně [[https://www.dokuwiki.org/cs:wiki:syntax|formátovat text]] a dodržovat strukturu nadpisů tak, aby následně vygenerovaná navigace dávala smysl
+[[https://github.com/vpsfreecz/dokuwiki-plugin-mlfarm|plugin]].
-  - u příkladů konfigurací uvádět pro jakou distribuci jsou psané, například Apache má jinou strukturu konfiguračních souboru v debian-based distrech než v RHEL-based
+Ten umožňuje stránky označit pomocí tagu ''%%<page>název stránky</page>%%''.
-  - pokud děláte větší úpravy v článku, který jste nepsali vy, je vhodné předem kontaktovat původního autora
+Stránky se stejným jménem jsou pak navzájem propojeny. Jména stránek se řídí
-  - pokud chcete o něčem psát napište mi. (Kontakt je níže)
+podle [[https://kb.vpsfree.org|anglické KB]].
+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
+kamkoli do české stránky následující tag:
+<code>
+<page>information:association</page>
+... text stránky ...
+</code>
+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.
+===== 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 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''.
+===== Dokumentace vpsAdminu =====
+==== Navigace ve vpsAdminu ====
+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:
+<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/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
+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 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/vpsfree-kb-contracts|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.
+==== Č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 =====
+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 [[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ě
+stránky pingne.
+Na stránce se maintaineři nastavují pomocí tagu ''%%<maintainers>%%'':
+<code>
+<maintainers>
+aither
+nick2 (prvni sekce)
+nick3 (druha sekce)
+</maintainers>
+</code>
+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>%%'':
+<code>
+<maintainer name="Moje jméno">
+irc nick_na_irc
+mail nekdo@domena.tld
+</maintainer>
+</code>
+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.
+<maintainers hidden>
+aither
+krcmar
+kerrycze
+</maintainers>
-O tuto KB se stará psjb. V případě jakýchkoliv návrhů, nápadů se mi nebojte dát vědět. [[jaroslav.shejbal@vpsfree.cz]]
-Pozn.: KB má stejnou databázi uživatelů jako vpsAdmin. Registrace jsou zablokovány. (**Momentálně přihlašování nefunguje, pokud chcete přispět, pište na kontaktní email!**)

Znalostní báze

Uživatelské nástroje

Nástroje pro tento web

Rozdíly

Nástroje pro stránku