Bidra til håndboken

Denne siden er en guide for deg som ønsker å foreslå endringer eller skrive nye sider i håndboken. Alle medlemmer kan bidra.

Prinsipper

• Ikke gjenta informasjon som allerede står i NROF sentralt sitt håndbok eller skytereglement – skriv heller lokale tillegg og presiseringer.
• Én side per tema. Hold sider korte og konkrete.
• Bruk sjekklister og tydelige overskrifter der det passer.
• Tenk gjennom hvilken målgruppe/mappe innholdet hører til (se tabellen under).

To måter å bidra på

1. Rask endring på en eksisterende side

• Se etter blyant-ikonet ("Rediger denne siden") øverst på siden du vil endre (vises når det er aktivert for siden).
• Det tar deg til filen på GitHub, hvor du kan redigere direkte i nettleseren.
• GitHub oppretter automatisk en branch og en pull request for deg når du lagrer.

2. Større endringer eller nye sider

1. Opprett en branch i repoet (eller bruk GitHubs verktøy for å opprette fil/branch direkte i nettleseren).
2. Legg til eller endre .md-filer under docs/.
3. Legger du til en helt ny side, må du huske å legge den inn i menyen (nav:-seksjonen) i mkdocs.yml – ellers vises den ikke i navigasjonen.
4. Åpne en pull request mot main.

Godkjenning (makkersjekk)

Alle endringer kvalitetssikres gjennom pull request og godkjenning – minst én annen person bør se gjennom og godkjenne endringen før den merges. Be gjerne en kollega/makker om å se over innholdet, spesielt for sikkerhets- eller rutinerelatert informasjon.

Når pull requesten er godkjent og merget til main, publiseres endringen automatisk i løpet av noen minutter på wiki.nrof-rog.no.

Hvor skal innholdet ligge?

Mappe	Målgruppe	Eksempel på innhold
docs/felles/	Alle medlemmer	Generell avdelingsintern informasjon
docs/standplassleder/	Standplassledere	Forberedelse, gjennomføring, etterarbeid
docs/styret/	Styremedlemmer	Informasjon begrenset til styret
docs/it/	IT-drift	Teknisk drift og arkitektur
docs/praktisk/	Alle bidragsytere	Denne siden og lignende skriveguider

Tenk på sensitivitet

Ikke legg inn personopplysninger utover navn og åpen kontaktinformasjon, passord/brukernavn, eller informasjon som kan skade avdelingen om den kommer på avveie – uansett mappe. Er du usikker, se advarslene øverst på styret- og it-sidene, eller spør styret/IT-drift.

Skriveformat (Markdown)

Håndboken bruker Markdown med noen ekstra funksjoner via mkdocs-material.

Advarsels-/tips-bokser:

!!! warning "Overskrift"
    Tekst i boksen.

Andre varianter: !!! tip, !!! note, !!! info.

Tabeller:

| Kolonne 1 | Kolonne 2 |
|---|---|
| Verdi | Verdi |

Sjekklister:

- [ ] Ugjort punkt
- [x] Utført punkt

Faner:

=== "Fane A"
    Innhold A

=== "Fane B"
    Innhold B

Lenker til andre sider i håndboken: bruk relativ sti, f.eks. [Se IT-drift](../it/index.md).

Forhåndsvis endringer lokalt (valgfritt)

Ønsker du å se hvordan siden ser ut før du sender inn en pull request:

pip install -r requirements.txt
mkdocs serve

Åpne deretter http://127.0.0.1:8000 i nettleseren.

Spørsmål?

Ta kontakt med IT-drift eller styret hvis du er usikker på hvor noe hører hjemme, eller om innhold er for sensitivt til å legges inn i håndboken.