Izboljšajte ta priročnik¶
Izvorno besedilo priročnika je v obliki Markdown v imeniku docs/, spletno mesto pa se gradi z MkDocs.
Lokalni predogled¶
Ustvarite virtualno okolje in namestite odvisnosti dokumentacije:
python3 -m venv .venv
. .venv/bin/activate
pip install --requirement requirements-docs.txt
mkdocs serve
Odprite lokalni naslov, ki ga natisne MkDocs. Predogled se znova zgradi, ko se izvorna datoteka spremeni.
Potrdite spletno mesto¶
Preden odprete zahtevo za vlečenje:
Stroga zgradba poroča o manjkajočih navigacijskih vnosih, neveljavnih povezavah, ki jih je zaznal MkDocs, in konfiguracijskih opozorilih.
Načela pisanja¶
- Pišite za določeno nalogo in občinstvo.
- Navedite različico MRBS, če je vedenje odvisno od izdaje.
- Dajte prednost preizkušenim primerom kot izčrpnim seznamom.
- Nikoli ne vključite pravih poverilnic ali zasebnih podatkov o rezervaciji.
- Povežite povezana opravila namesto podvajanja velikih razdelkov.
- Posodobite vse razpoložljive prevode, ko je to praktično.
Prevodi¶
Referenčno besedilo je angleščina. Nemške, francoske in španske strani uporabljajo isto relativno pot s pripono lokalne nastavitve:
Če prevod manjka, se spletno mesto vrne v angleščino. Prevod mora ohraniti kodo, imena nastavitev, opozorila in povezave, hkrati pa uporabljati naravno terminologijo v ciljnem jeziku.
Področje uporabe¶
To drevo dokumentacije je namenjeno MRBS 1.12.2. Spremembe, ki opisujejo poznejšo izdajo, morajo posodobiti vidni obseg različice ali pa jih je treba razviti v kompletu dokumentacije za to izdajo.