Popraw tę instrukcję¶
Podręcznik zapisano w formacie Markdown w katalogu docs/; witryna jest budowana za pomocą MkDocs.
Podgląd lokalny¶
Utwórz środowisko wirtualne i zainstaluj zależności dokumentacji:
python3 -m venv .venv
. .venv/bin/activate
pip install --requirement requirements-docs.txt
mkdocs serve
Otwórz adres lokalny wydrukowany przez MkDocs. Podgląd jest odtwarzany po zmianie pliku źródłowego.
Zweryfikuj witrynę¶
Przed otwarciem żądania ściągnięcia:
Ścisła kompilacja raportuje brakujące wpisy nawigacyjne, nieprawidłowe łącza wykryte przez MkDocs i ostrzeżenia dotyczące konfiguracji.
Zasady pisania¶
- Pisz pod konkretne zadanie i odbiorców.
- Podaj wersję MRBS, jeśli zachowanie jest specyficzne dla wydania.
- Preferuj sprawdzone przykłady zamiast wyczerpujących list.
- Nigdy nie podawaj prawdziwych danych uwierzytelniających ani prywatnych danych rezerwacji.
- Łącz powiązane zadania zamiast powielać duże sekcje.
- Zaktualizuj wszystkie dostępne tłumaczenia, jeśli jest to praktyczne.
Tłumaczenia¶
Tekstem referencyjnym jest język angielski. Strony w języku niemieckim, francuskim i hiszpańskim używają tej samej ścieżki względnej z przyrostkiem ustawień regionalnych:
W przypadku braku tłumaczenia strona powraca do języka angielskiego. Tłumaczenie powinno zachować kod, ustawienia nazw, ostrzeżenia i łącza, jednocześnie używając naturalnej terminologii w języku docelowym.
Zakres¶
To drzewo dokumentacji dotyczy wersji MRBS 1.12.2. Zmiany opisujące późniejszą wersję muszą aktualizować widoczny zakres wersji lub zostać opracowane w zestawie dokumentacji dla tej wersji.