Kursmateriale for IN2000 (Software Engineering med Prosjektarbeid) ved UiO.
Dette repoet brukes for å generere siten https://in2000.met.no/ som hostes via GitHub Pages.
Aller først må du laste ned repoet fra GitHub. Dette krever at du har en bruker på GitHub (i utgangspunktet privat).
$ git clone [email protected]:metno/in2000.git
For å skrive dokumentasjon må du bruke formatet Markdown. Se dokumentasjonen for GitHub Pages for mer informasjon.
Selve siten ligger i mappen /docs
, og er organisert etter årstall.
Materiale for årets kurs ligger i mappen med inneværende år som navn med én fil
for hvert case.
Alt som ikke skal vises på selve siten, men skal kunne lastes ned og integreres
i app-koden skal legges i mappen /resources
. Dermed kan studentene laste ned
disse hva Git og få løpende oppdateringer.
Før du commiter endringer bør du teste at siten fungerer på din lokale maskin.
-
Installer Jekyll etter denne oppskriften.
-
Installer gems og generer siten:
$ cd doc
$ bundle install
$ ./site run
Du vil da kunne se resultatet i din browser på følgende adresse:
Lag en pull request i GitHub, så vil vi reviewe endringene og merge inn i master.