GitHub
NL Design System is open source. Daarom is een open platform zoals GitHub de logische plek om samen te werken en code te delen.
Repositories
Je vindt de projecten van NL Design System in verschillende repositories op GitHub. Elke repository heeft een eigen doel. Hieronder vind je een toelichting op een aantal repositories.
Example: de template repository
De example repository is een template waarmee je een Storybook-omgeving bouwt voor je eigen communityproject. Veel bestaande projecten gebruiken dit template als basis.
Candidate
De candidate repository dient voor het bouwen en onderhouden van de Candidate components.
Community repositories
Dit zijn design systems die organisaties uit de community zelf maken en onderhouden. Ze werken hierbij volgens het estafettemodel. Groeit een component door naar de 'Candidate'- of 'Hall of Fame'-fase? Dan kan de community dit hergebruiken zonder dat er grote aanpassingen nodig zijn.
Terraform
In de Terraform-repository vind je alles over de infrastructuur. Vanuit hier wordt de infrastructuur gebouwd en beheerd. Je kunt hier terecht als je bijvoorbeeld schrijfrechten nodig hebt of een versienummer van Node.js wilt bijwerken.
nldesignsystem.nl
Deze website, inclusief de pagina die je nu leest, staat in de documentatie-repository. Kom je een fout tegen op de website? Maak dan een Pull Request (PR) aan als je weet hoe. Elke bijdrage is zeer welkom, je kunt je suggestie ook delen op Slack-community.
gebruikersonderzoeken.nl
De gebruikersonderzoeken repository bevat de broncode voor de website gebruikersonderzoeken.nl. Op deze website vind je gebruikersonderzoek dat binnen de overheid is uitgevoerd. Omdat de website is gemaakt met Astro en NL Design System componenten, is het een interessante repository voor developers om eens in de code te kijken.
Theming en design tokens
De nl-design-system/themes repository is de centrale plek voor huisstijlen in de vorm van design tokens. Deze repository is bedoeld voor twee situaties:
- Voor organisaties die een huisstijl publiceren: Je kunt hier de design tokens van je huisstijl publiceren zonder dat je een volledige, eigen repository hoeft te onderhouden.
- Voor organisaties die componenten ontwikkelen: Je kunt hier controleren hoe jouw component eruitziet met de huisstijlen van andere organisaties.
Storybook-integratie
Storybook wordt gebruikt om de componentenbibliotheek te tonen en te documenteren, compleet met code en voorbeelden. De meeste repositories bevatten een link naar de bijbehorende Storybook.
NL Design System verzorgt zelf geen hosting voor de websites van design systems. De community lost dit in de praktijk vaak op met de volgende oplossingen:
- Voor de productie-omgeving wordt meestal GitHub Pages gebruikt.
- Voor de testomgeving wordt vaak gebruikgemaakt van branch deployments, die gehost worden op Vercel.
Documentatie en versiebeheer
We slaan de inhoud van websites niet op in een CMS, maar die publiceren we vanuit Git. Richtlijnen, handleidingen en voorbeelden staan direct in de GitHub-repositories, meestal in de vorm van Markdown-bestanden.
Dankzij het versiebeheer van Git en GitHub kun je altijd oudere versies van componenten, richtlijnen en documentatie terugvinden.
Back-ups
De GitHub-omgeving krijgt dagelijks een back-up met de tool Rewind.
Let op: GitHub Discussions en GitHub Projects vallen buiten deze back-up.
Alternatieven, zoals GitLab
Kun je het NL Design System ook met GitLab gebruiken? Ja, dat kan zeker. Een project als het PRA Design System heeft dit bijvoorbeeld al gedaan.
De community gebruikt momenteel vooral GitHub Actions. Hierdoor is er geen kant-en-klare implementatie beschikbaar voor GitLab CI Pipelines. Je staat er echter niet alleen voor.
Wil je hierover meedenken of heb je hulp nodig? Kom dan naar de Developer Open Hour om er verder over te praten.