Poboljšajte ovaj priručnik¶
Izvorni tekst priručnika čuva se u Markdown formatu u direktorijumu docs/, a sajt se generiše pomoću MkDocs-a.
Lokalni pregled¶
Kreirajte virtuelno okruženje i instalirajte zavisnosti od dokumentacije:
python3 -m venv .venv
. .venv/bin/activate
pip install --requirement requirements-docs.txt
mkdocs serve
Otvorite lokalnu adresu koju je odštampao MkDocs. Pregled se ponovo gradi kada se izvorna datoteka promeni.
Potvrdite sajt¶
Pre otvaranja zahteva za povlačenje:
Stroga verzija izveštava da nedostaju unosi za navigaciju, nevažeće veze koje je otkrio MkDocs i upozorenja o konfiguraciji.
Principi pisanja¶
- Pišite za određeni zadatak i publiku.
- Navedite verziju MRBS kada je ponašanje specifično za izdanje.
- Dajte prednost testiranim primerima nego iscrpnim listama.
- Nikada nemojte uključivati stvarne akreditive ili privatne podatke o rezervaciji.
- Povežite povezane zadatke umesto da duplirate velike delove.
- Ažurirajte sve dostupne prevode kada je to praktično.
Prevodi¶
Engleski je referentni tekst. Nemačke, francuske i španske stranice koriste istu relativnu putanju sa sufiksom lokalizacije:
Kada prevod nedostaje, sajt se vraća na engleski. Prevod treba da sačuva kod, nazive podešavanja, upozorenja i veze dok koristi prirodnu terminologiju na ciljnom jeziku.
Obim¶
Ovo stablo dokumentacije cilja MRBS 1.12.2. Promene koje opisuju kasnije izdanje moraju ažurirati vidljivi opseg verzije ili biti razvijene u dokumentaciji setu za to izdanje.