tromsoskapere/mkdocs-skogstua
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Speil av git.protonord.no/Tromsoskapere/mkdocs-skogstua
289 commits 2 branches 0 tags 14 MiB
Find a file
Exact
CoolAEW 09ebb952fa Navnendring kjøkken
2026-05-06 00:45:02 +02:00
.github/workflows Update ci.yml 2025-10-27 10:38:07 +01:00
docs Navnendring kjøkken 2026-05-06 00:45:02 +02:00
.gitignore Ignore files created by the OS 2025-11-06 09:30:57 +01:00
mkdocs.yml La til knapp for å redigere siden på github 2025-11-10 22:43:52 +01:00
README.md Oppdatert info om bilder 2025-11-09 17:57:46 +01:00
requirements.in Create requirements.in 2025-10-26 23:21:05 +01:00
requirements.txt 2025-10-26 23:32:48 +01:00

README.md

Dokumentasjon for 🏡 Skogstua fellesverksted 🏡

Velkommen! Dette er "lageret" (repoet) for all dokumentasjon på docs.tromsoskapere.no

Målet er at alle i foreningen skal kunne bidra med oppdatering av dokumentasjonen for verkstedet. Du trenger ikke installere egen programvare for å gjøre enkle tekstendringer. Ved å redigere filer her på GitHub vil hjemmesiden oppdateres etter en admin har godkjent endringen.

Navigasjonsstrukturen på docs.tromsoskapere.no er en direkte avspeiling av katalogstrukturen i /docs/. Filene er lagret i markdown-format, med .md endelse. Hver fil blir en egen html side. Alle .md filer må starte med # Tittel. Bilder laster du opp i images mappen og legger inn med ![Bildetekst](/images/eksempelbilde.png)

Veiledning

🛑 Før du starter: GitHub-bruker og tilgang

For å kunne foreslå endringer som beskrevet i guiden under, må du ha en gratis GitHub-bruker.

  1. Opprett bruker: Gå til github.com for å registrere deg hvis du ikke har en bruker fra før.
  2. Be om tilgang: Send en melding til en administrator (Alf eller Torbjørn, eller i Discord-kanalen) med GitHub-brukernavnet ditt. Du må legges til som medlem i organisasjonen vår før du kan lagre endringer.

Når du har fått tilgang, kan du følge guiden under. (For erfarne GitHub brukere: Det er også mulig å clone repoet og jobbe på en ekstern PR som kan merges.)

✏️ Slik gjør du en endring

Den enkleste måten å redigere på er å bruke GitHubs egen innebygde fil-editor. Du kan også bruke VSCODE (Web) hvis du foretrekker det.

1. Finn filen du vil endre

  • Alle sidene på nettsiden ligger i docs/-mappen.
  • Bruk filutforskeren på denne siden til å navigere deg frem til riktig fil (f.eks. docs/kjelleren/maskinrom/pussemaskin.md).
  • Klikk på filnavnet for å åpne og lese filen.

2. Åpne editoren

  • Oppe til høyre over filinnholdet, klikk på blyant-ikonet (✏️) for å "Edit this file".

3. Gjør endringen

  • Du er nå i en enkel teksteditor.
  • Rediger teksten akkurat som i et vanlig tekstdokument. Husk å start teksten med # Tittel Sidene er skrevet i Markdown.

4. Lagre endringen ("Propose changes")

Når du er fornøyd, må du lagre endringen din.

  1. Scroll helt nederst på siden til du ser en boks som heter "Commit changes".
  2. I den første tekstboksen, skriv en kort melding om HVA du gjorde (f.eks. "Oppdaterte info om pussemaskin").
  3. La "Create a new branch..."-valget stå (dette er påkrevd).
  4. Trykk på den grønne knappen "Propose changes".

5. Opprett en "Pull Request" (PR)

Du har nå lagret endringen din på en "kladd". Nå må du formelt be om at den blir en del av den endelige nettsiden.

  1. GitHub tar deg automatisk til en ny side som heter "Open a pull request".
  2. Du trenger ikke fylle ut noe mer. Bare trykk på den store, grønne knappen "Create pull request".

Ferdig! Du har nå sendt inn et endringsforslag. Det eneste som gjenstår er at en administrator godkjenner den.

For admins

  1. Hvis det ligger pull requests inne må disse godkjennes.
  2. Alle endringer på main blir publisert når du kjører workflowen "🚀 Deploy docs.tromsoskapere.no". Dette gjør du med Actions -> velg workflow -> Run workflow