DRAFT VERSION - NOT AN OFFICIALLY APPROVED DOCUMENT

GitHub eller Nextcloud?

OS2 bruger både Nextcloud og GitHub til fildeling og dokumentation. Værktøjerne har forskellige styrker, og de kan bruges sammen.

Her får du overblik over, hvad de egner sig til, og hvad du skal være opmærksom på, når I organiserer dokumentationen for et OS2-produkt eller -projekt.

Indholdsfortegnelse

  1. Hvad bruger vi værktøjerne til?
    1. Nextcloud
    2. GitHub
  2. Fælles praksis for fildeling
  3. Husk at dokumentere jeres struktur

Hvad bruger vi værktøjerne til?

Nextcloud

Nextcloud er OS2’s fælles fildrev og bruges til opbevaring og deling af dokumenter.

Det er blandt andet relevant til:

  • Mødereferater og dagsordener
  • Aftaledokumenter og regnskaber
  • Andre administrative dokumenter
  • Filer, som flere skal kunne tilgå og arbejde med

Nextcloud har både interne og offentlige mapper.

Se Brug Nextcloud for praktisk vejledning.

GitHub

GitHub er en platform til versionsstyring og samarbejde om udvikling og dokumentation.

Det er blandt andet relevant til:

  • Kildekode og teknisk dokumentation
  • Registrering af fejl og udviklingsopgaver (issues)
  • Dokumentation, hvor ændringer og versionshistorik er vigtige
  • Samarbejde om dokumentation i Markdown

GitHub kan også bruges til fildeling, når det giver mening for produktet eller projektet.

Fælles praksis for fildeling

Nextcloud og GitHub er OS2’s fælles værktøjer til fildeling og dokumentation. Det er disse værktøjer, sekretariatets vejledning og support tager udgangspunkt i.

Enkelte produkter og projekter anvender også andre platforme. Hvis det gælder hos jer, er det vigtigt at beskrive, hvor dokumentationen findes, og hvordan den tilgås.

Vær opmærksom på: OS2-sekretariatet kan ikke garantere hjælp og support til andre platforme end de fælles værktøjer.

Læs mere om principper for valg af fælles værktøjer.

Husk at dokumentere jeres struktur

Produktet eller projektet har ansvar for at beskrive, hvor dokumentationen opbevares.

Alle OS2-produkter og -projekter skal have en README-fil i deres offentlige Nextcloud-mappe. Den fungerer som vejviser til dokumentationen – også hvis I primært bruger GitHub.

Se Opret en README for vejledning og skabelon.