Vylepšete tuto příručku¶
Příručka je udržována ve formátu Markdown v adresáři docs/ a generuje se pomocí MkDocs.
Místní náhled¶
Vytvořte virtuální prostředí a nainstalujte závislosti dokumentace:
python3 -m venv .venv
. .venv/bin/activate
pip install --requirement requirements-docs.txt
mkdocs serve
Otevřete místní adresu vypsanou nástrojem MkDocs. Po změně zdrojového souboru se náhled automaticky znovu sestaví.
Kontrola webu¶
Před vytvořením pull requestu spusťte:
Sestavení v přísném režimu ohlásí chybějící položky navigace, neplatné odkazy zjištěné nástrojem MkDocs a varování konfigurace.
Zásady psaní¶
- Pište pro konkrétní úkol a publikum.
- Pokud je chování specifické pro vydání, uveďte verzi MRBS.
- Upřednostňujte testované příklady před vyčerpávajícími seznamy.
- Nikdy neuvádějte skutečné přihlašovací údaje nebo soukromé rezervační údaje.
- Propojte související úkoly namísto duplikování velkých sekcí.
- Aktualizujte všechny dostupné překlady, jakmile to bude praktické.
Překlady¶
Referenčním textem je angličtina. Přeložené stránky používají stejnou relativní cestu doplněnou o kód jazyka, například:
Pokud překlad chybí, zobrazí se anglická verze stránky. Překlad musí zachovat kód, názvy nastavení, upozornění a odkazy a zároveň používat přirozenou terminologii cílového jazyka.
Rozsah¶
Tato dokumentace se vztahuje k MRBS 1.12.2. Změny popisující novější verze musejí upravit viditelně uvedený rozsah verzí nebo vzniknout v samostatné sadě dokumentace pro příslušnou verzi.