Vylepšite túto príručku¶
Zdrojové texty príručky sú vo formáte Markdown v adresári docs/; webová lokalita sa vytvára pomocou MkDocs.
Miestny náhľad¶
Vytvorte virtuálne prostredie a nainštalujte závislosti dokumentácie:
python3 -m venv .venv
. .venv/bin/activate
pip install --requirement requirements-docs.txt
mkdocs serve
Otvorte miestnu adresu vytlačenú MkDocs. Ukážka sa znova vytvorí, keď sa zmení zdrojový súbor.
Overte lokalitu¶
Pred otvorením žiadosti o stiahnutie:
Prísne zostavenie hlási chýbajúce navigačné položky, neplatné odkazy zistené MkDocs a konfiguračné upozornenia.
Zásady písania¶
- Píšte pre konkrétnu úlohu a publikum.
- Ak je správanie špecifické pre vydanie, uveďte verziu MRBS.
- Uprednostňujte testované príklady pred vyčerpávajúcimi zoznamami.
- Nikdy neuvádzajte skutočné prihlasovacie údaje ani údaje o súkromných rezerváciách.
- Prepojte súvisiace úlohy namiesto duplikovania veľkých sekcií.
- Aktualizujte všetky dostupné preklady, keď to bude praktické.
Preklady¶
Referenčným textom je angličtina. Nemecké, francúzske a španielske stránky používajú rovnakú relatívnu cestu s príponou miestneho nastavenia:
Ak chýba preklad, stránka sa vráti do angličtiny. Preklad by mal zachovať kód, názvy nastavení, varovania a odkazy pri použití prirodzenej terminológie v cieľovom jazyku.
Rozsah¶
Tento strom dokumentácie sa zameriava na MRBS 1.12.2. Zmeny popisujúce neskoršie vydanie musia aktualizovať rozsah viditeľných verzií alebo musia byť vyvinuté v sade dokumentácie pre toto vydanie.