Forbedre denne håndboken¶
Håndboken vedlikeholdes som Markdown i docs/-katalogen og bygget med MkDocs.
Lokal forhåndsvisning¶
Opprett et virtuelt miljø og installer dokumentasjonsavhengighetene:
python3 -m venv .venv
. .venv/bin/activate
pip install --requirement requirements-docs.txt
mkdocs serve
Åpne den lokale adressen skrevet ut av MkDocs. Forhåndsvisningen gjenoppbygges når en kildefil endres.
Valider nettstedet¶
Før du åpner en pull-forespørsel:
Den strenge byggingen rapporterer manglende navigasjonsoppføringer, ugyldige lenker som MkDocs oppdager, og konfigurasjonsadvarsler.
Skriveprinsipper¶
- Skriv for en spesifikk oppgave og målgruppe.
- Oppgi MRBS-versjonen når oppførselen er utgivelsesspesifikk.
- Foretrekk testede eksempler fremfor uttømmende lister.
- Ta aldri med ekte legitimasjon eller private bestillingsdata.
- Koble til relaterte oppgaver i stedet for å duplisere store deler.
- Oppdater alle tilgjengelige oversettelser når det er praktisk mulig.
Oversettelser¶
Engelsk er referanseteksten. Tyske, franske og spanske sider bruker den samme relative banen med et lokalitetssuffiks:
Når en oversettelse mangler, faller siden tilbake til engelsk. En oversettelse bør bevare kode, angi navn, advarsler og lenker mens den bruker naturlig terminologi på målspråket.
Omfang¶
Dette dokumentasjonstreet retter seg mot MRBS 1.12.2. Endringer som beskriver en senere utgivelse må oppdatere det synlige versjonsomfanget eller utvikles i dokumentasjonssettet for den utgivelsen.