Dokumentation og fildeling
DRAFT: Vejledninger og dokumentation herunder er under udarbejdelse. Der vil være informationer, som stadig er uafklarede og kan ændres
Her finder du praktiske vejledninger til at organisere, opbevare og dele dokumentation for OS2-produkter og -projekter.
Dokumentation kan være fordelt på flere arkiver og platforme. Derfor har vi samlet vejledningerne her, så du lettere kan finde, organisere og dele dokumentation på tværs.
Vælg en vejledning i sidemenuen for at komme i gang.
Nextcloud og GitHub
OS2 stiller Nextcloud og GitHub til rådighed til dokumentation og samarbejde.
Nextcloud bruges til opbevaring og deling af filer. OS2 har både et offentligt filarkiv, hvor alle kan læse og hente dokumenter, og adgangsbegrænsede områder, hvor produkter og projekter kan samarbejde.
GitHub bruges blandt andet til udvikling, dokumentation, versionsstyring og samarbejde. Her kan man arbejde med både offentlige og private repositories.
Hidtil har det offentlige filarkiv i Nextcloud været det centrale sted for blandt andet referater og anden fælles dokumentation. Fremadrettet kan dokumentationen også placeres på eksempelvis GitHub. Det afgørende er, at dokumentationen som udgangspunkt er offentligt tilgængelig og let at finde.
Alle OS2-produkter og -projekter skal have en README i både det offentlige filarkiv i Nextcloud og på GitHub. README-filerne beskriver indholdet og viser vej til dokumentation andre steder.
Tænk på vedligeholdelsen: Overvej, hvor dokumentationen bedst kan opbevares og holdes opdateret. Undgå så vidt muligt at vedligeholde det samme dokument flere steder. Brug i stedet README-filerne til at vise vej.