Als community moet je een plek hebben om de code-bestanden te bewaren, onder versiebeheer. Maar je hebt vaak veel meer projectdocumenten, zoals:
- een website als "publiek gezicht" van het project
- een lijst met "issues": vragen, fouten, wensen, enz.
- een planning en voortgang van de deeltaken
- agenda's en notulen van bijeenkomsten
- ...
Je moet een plek hebben waar je deze kunt aanmaken, inzien en bewaren.
:::{figure} figs/github-logo-2.png :width: 100 :align: right
Github
Octocat
:::
GitHub (https://github.com)is begonnen als een plek voor het bewaren van de code-repositories van software projecten, voornamelijk van open source software. Inmiddels hebben heel veel open source projecten een plek op GitHub gevonden.
Tegenwoordig biedt GitHub ook onderdak voor de andere documenten:
- via GitHub Pages kun je de website van je project publiceren;
- bij een repository kun je de issues daarover melden; en de discussie daarover voeren;
- via de projects kun je taken plannen en de voortgang daarvan bijhouden;
- agenda's en notulen ???
:::{figure} figs/github-flow.png :width: 650
GitHub flow
:::
Een software-project omvat meestal een groot aantal bestanden die samen een consistent geheel moeten vormen. Hiervoor is versiebeheer essentieel. Tegenwoordig wordt daarvoor vaak git gebruikt, net als Linux bedacht door Linus Torvalds. Op basis van git maakt GitHub het mogelijk om een afgeleide versie te maken van een oorspronkelijke versie waarbij je wijzigingen in het origineel later nog kunt doorvoeren in de afgeleide versie, en omgekeerd.
Dit is een eigenschap die voor open leermaterialen ook essentieel is: je wilt verbeteringen in de originele versie ook kunnen verwerken in je eigen afgeleide versie; en sommige verbeteringen in je afgeleide versie wil je terug kunnen voeren in de originele versie.
GitHub maakt het ook mogelijk om de wijzigingen te koppelen aan issues die gemeld zijn.
:::{figure} figs/gh-issue-list.png :width: 300
Lijst met issues
:::
GitHub maakt het de gebruikers van de software gemakkelijk om fouten, wensen en vragen te melden, die vervolgens in het project afgehandeld kunnen worden.
:::{figure} figs/jb-issue-button.png :width: 250 :align: right
Melden van een issue
:::
In Jupyter Book kan een gebruiker (mits deze een GitHub account heeft, zoals veel informatica-leerlingen) gemakkelijk een fout melden of een verbetering suggereren.
:::{figure} figs/jb-activity-board.png :width: 700
Jupyter Book project - planning
:::
In een GitHub project kun je een planning maken op basis van taken, die gekoppeld kunnen zijn aan issues. Je kunt deze taken toewijzen aan personen; en je kunt de voorgang volgen, bijvoorbeeld via een "KanBan bord".
:::{margin} Dit "open boek" is ook een voorbeeld van een statische website. :::
Via GitHub Pages kun je een statische website maken bij een project, bijvoorbeeld als publiek gezicht van het project op het web.
GitHub is een plek waar leerlingen kennis kunnen maken met open source software, en de manier van werken daarbij. Ze krijgen via GitHub in kijkje in de keuken van open source software: ze kunnen niet alleen de software zelf bekijken, maar ook zien hoe daaraan gewerkt wordt, omdat vrijwel alle relevante documentatie daar te vinden is.