Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add workflow for formatting md code #126

Closed
wants to merge 9 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .github/workflows/prettier.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Format md files

on:
pull_request:
branches:
- main
- release

jobs:
prettier:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Prettify code
uses: creyD/[email protected]
with:
# This part is also where you can pass other options, for example:
prettier_options: --write **/*.md --no-error-on-unmatched-pattern
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs/overhetalgoritmekader/CONTRIBUTING.md
71 changes: 41 additions & 30 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@ Het zal het voor het team van het Algoritmekader een stuk makkelijker maken en d
We kijken uit naar alle bijdragen! 🎉

> ## Opmerking
>
> Werken in Github is voor het team Algoritmekader nieuw en experimenteel.
> Dit vraagt voor ons om een aangepaste werkwijze en hier is bepaalde expertise voor nodig.
> Het begin is gemaakt en het team Algoritmekader is nog lerende om hier optimaal invulling aan te geven.
> Hierdoor kan het iets langer duren voordat er wordt gereageerd op suggesties of toevoegingen.
> Dit vraagt voor ons om een aangepaste werkwijze en hier is bepaalde expertise voor nodig.
> Het begin is gemaakt en het team Algoritmekader is nog lerende om hier optimaal invulling aan te geven.
> Hierdoor kan het iets langer duren voordat er wordt gereageerd op suggesties of toevoegingen.
> We werken aan een duidelijk proces om hier goed mee om te gaan (deze guidelines zijn daar een voorbeeld van).
> Daarnaast werken we niet aan alle bouwblokken tegelijk. Deze worden één voor één opgepakt.
> Aanbevelingen over onderwerpen die later op de planning staan kunnen daardoor ook iets langer duren om te verwerken, en worden mogelijk pas verwerkt wanneer dit bouwblok wordt uitgewerkt.
> Daarnaast werken we niet aan alle bouwblokken tegelijk. Deze worden één voor één opgepakt.
> Aanbevelingen over onderwerpen die later op de planning staan kunnen daardoor ook iets langer duren om te verwerken, en worden mogelijk pas verwerkt wanneer dit bouwblok wordt uitgewerkt.

## Inhoudsopgave

Expand All @@ -25,6 +26,7 @@ We kijken uit naar alle bijdragen! 🎉
- [Hoe we werken op GitHub](#hoe-we-werken-op-github)

### Code of Conduct

Dit project en iedereen die eraan deelneemt, valt onder de
[Code of Conduct](https://github.com/MinBZK/Algoritmekader?tab=coc-ov-file#readme).
Door deel te nemen, wordt van je verwacht dat je je aan deze code houdt. Meld onacceptabel gedrag
Expand All @@ -34,9 +36,9 @@ aan **[[email protected]](mailto:[email protected])**.

### Maak een issue aan

Voordat je een [Issues](https://github.com/MinBZK/Algoritmekader/issues) gaat aanmaken, kan je bekijken of jouw vraag al tussen de bestaande [Issues](https://github.com/MinBZK/Algoritmekader/issues) staat. Wellicht staat er al een issue tussen die jou vraag kan beantwoorden.
Voordat je een [Issues](https://github.com/MinBZK/Algoritmekader/issues) gaat aanmaken, kan je bekijken of jouw vraag al tussen de bestaande [Issues](https://github.com/MinBZK/Algoritmekader/issues) staat. Wellicht staat er al een issue tussen die jou vraag kan beantwoorden.

Als je jouw vraag nog steeds wilt stellen, kan je een [Issue](https://github.com/MinBZK/Algoritmekader/issues) aanmaken.
Als je jouw vraag nog steeds wilt stellen, kan je een [Issue](https://github.com/MinBZK/Algoritmekader/issues) aanmaken.

1. Gebruik daarvoor de knop new issue.
2. Schrijf je vraag of opmerking is en geef een heldere toelichting.
Expand All @@ -48,29 +50,35 @@ Als je jouw vraag nog steeds wilt stellen, kan je een [Issue](https://github.com
Je kan je vragen ook altijd stellen door een mail te sturen naar **[[email protected]](mailto:[email protected])**.

## Ik wil iets bijdragen
Er zijn verschillende manieren waarop je kan bijdragen. Zie hieronder de mogelijkheden.

Er zijn verschillende manieren waarop je kan bijdragen. Zie hieronder de mogelijkheden.

> #### Ter kennisgeving
>
> Wanneer je bijdraagt aan dit project, moet je ermee akkoord gaan dat je 100% van de inhoud hebt geschreven, dat je de benodigde rechten op de inhoud hebt en dat de inhoud die je bijdraagt mag worden geleverd onder de Code of Conduct.

### Sluit je aan bij een werkgroep

Voor sommige bouwblokken wordt er gewerkt met werkgroepen, om de informatie verder uit te werken. Deelname aan een werkgroep kost tijd. Werkgroepen komen regelmatig bij elkaar, en tussendoor worden bepaalde zaken uitgewerkt door werkgroepleden. Wil je op één van de onderwerpen meewerken? Stuur dan een bericht naar **[[email protected]](mailto:[email protected])**.

### Neem deel aan een sprint review / klankbord / demo
Het team van het algoritmekader werkt in sprints van ongeveer 3 weken. Daarin werken we toe naar de volgende release van het Algoritmekader. Ongeveer eens in de 6 weken vindt er een nieuwe release plaats. Wanneer er een release is, wordt deze altijd toegelicht en gepresenteerd in een open online review / demo. Deze kan je vrijblijvend volgen. Zo blijf je op de hoogte en kun je een bijdrage leveren. [Bekijk de agenda op Algoritmes Pleio](https://algoritmes.pleio.nl/events) voor de komende bijeenkomsten.

Het team van het algoritmekader werkt in sprints van ongeveer 3 weken. Daarin werken we toe naar de volgende release van het Algoritmekader. Ongeveer eens in de 6 weken vindt er een nieuwe release plaats. Wanneer er een release is, wordt deze altijd toegelicht en gepresenteerd in een open online review / demo. Deze kan je vrijblijvend volgen. Zo blijf je op de hoogte en kun je een bijdrage leveren. [Bekijk de agenda op Algoritmes Pleio](https://algoritmes.pleio.nl/events) voor de komende bijeenkomsten.

### Ik wil een fout / bug melden
Heb je een foutje gevonden in het Algoritmekader? Dan kan je deze melden door een [Issue](https://github.com/MinBZK/Algoritmekader/issues) aan te maken.

Voordat je een [Issues](https://github.com/MinBZK/Algoritmekader/issues) gaat aanmaken, kan je bekijken of jouw gevonden fout al tussen de bestaande [Issues](https://github.com/MinBZK/Algoritmekader/issues) staat.
Heb je een foutje gevonden in het Algoritmekader? Dan kan je deze melden door een [Issue](https://github.com/MinBZK/Algoritmekader/issues) aan te maken.

Voordat je een [Issues](https://github.com/MinBZK/Algoritmekader/issues) gaat aanmaken, kan je bekijken of jouw gevonden fout al tussen de bestaande [Issues](https://github.com/MinBZK/Algoritmekader/issues) staat.

Als je de gevonden fout nog steeds wilt melden, kan je een [Issue](https://github.com/MinBZK/Algoritmekader/issues) aanmaken.
Als je de gevonden fout nog steeds wilt melden, kan je een [Issue](https://github.com/MinBZK/Algoritmekader/issues) aanmaken.

1. Gebruik daarvoor de knop new issue.
2. Beschrijf de fout duidelijk en geef een heldere toelichting. Voeg waar mogelijk een screenshot toe.
2. Beschrijf de fout duidelijk en geef een heldere toelichting. Voeg waar mogelijk een screenshot toe.
3. Het team van het Algoritmekader zal deze issue labelen als `bug` en pakt jouw issue zo snel mogelijk op. Mogelijk neemt het team van het Algoritmekader contact op voor een verduidelijking of een oplossing.

### Ik wil een verbetering voorstellen

Heb je een suggestie of wil je een verbetering voorstellen? Dat kan gaan om een compleet nieuwe functionaliteit van de site of om kleine verbeteringen. Het volgen van onderstaande instructie helpt het team van het algoritmekader om je suggestie te begrijpen en gerelateerde suggesties te vinden.

Je kan een suggestie doen door een [Issue](https://github.com/MinBZK/Algoritmekader/issues) aan te maken of door een Pull Request te maken.
Expand All @@ -79,40 +87,43 @@ Je kan een suggestie doen door een [Issue](https://github.com/MinBZK/Algoritmeka

- Voordat je een suggestie gaat maken, kan je bekijken of jouw suggestie al tussen de bestaande [Issues](https://github.com/MinBZK/Algoritmekader/issues) staat. Wellicht bestaat er al een issue die jouw suggestie beschrijft, en zijn we er al mee bezig.
- Zoek uit of jouw idee past binnen het doel en de scope van het project. Wat zijn de voordelen van deze functionaliteit of toevoeging? Het is aan jou om het team van het Algoritmekader en de community te overtuigen dat dit een nuttige toevoeging is aan het Algoritmekader. Houd in gedachten dat we functioanliteiten willen die nuttig zijn
voor de meerderheid van onze gebruikers en niet slechts voor een kleine groep.
voor de meerderheid van onze gebruikers en niet slechts voor een kleine groep.

#### Een issue aanmaken

Als je jouw suggestie nog steeds wilt doen, kan je een [Issue](https://github.com/MinBZK/Algoritmekader/issues) aanmaken.
Als je jouw suggestie nog steeds wilt doen, kan je een [Issue](https://github.com/MinBZK/Algoritmekader/issues) aanmaken.

1. Gebruik daarvoor de knop new issue.
2. Beschrijf duidelijk jouw suggestie en geef een heldere toelichting en onderbouwing waarom dit een goede toevoeging zal zijn aan het Algoritmekader
3. Het team van het Algoritmekader zal deze issue labelen als `enhancement` en pakt jouw issue zo snel mogelijk op. Mogelijk neemt het team van het Algoritmekader contact op voor een verduidelijking of een oplossing.
> Afhankelijk van de complexiteit en het onderwerp van jouw suggestie kan het even duren voordat deze wordt opgepakt door het team van het Algoritmekader.

> Afhankelijk van de complexiteit en het onderwerp van jouw suggestie kan het even duren voordat deze wordt opgepakt door het team van het Algoritmekader.

#### Een pull-request maken
Kun je niet uit de voeten met de issues?

Kun je niet uit de voeten met de issues?
Bijvoorbeeld omdat je verschillende wijzigingsvoorstellen wilt doen? Je kan ook gebruik maken van een [Fork en een Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks).

Het team van Algoritmekader bekijkt daarna jouw aanpassingen en kan bij akkoord jouw aanpassingen *mergen*. Er zijn ook andere manieren om een pull request te doen. [Meer daarover](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
Het team van Algoritmekader bekijkt daarna jouw aanpassingen en kan bij akkoord jouw aanpassingen _mergen_. Er zijn ook andere manieren om een pull request te doen. [Meer daarover](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).

> Afhankelijk van de complexiteit en het onderwerp van jouw suggestie kan het even duren voordat deze wordt opgepakt door het team van het Algoritmekader.
> Afhankelijk van de complexiteit en het onderwerp van jouw suggestie kan het even duren voordat deze wordt opgepakt door het team van het Algoritmekader.

> #### Preview van een pull-request
> We maken gebruik van de tool [pr-preview-action](https://github.com/rossjrw/pr-preview-action) om automatisch previews te maken van een pull-request.
Dit maakt het mogelijk om de wijzigingen die zijn gedaan in een pull-request al te bekijken in de uiteindelijke omgeving.
> Wanneer er een pull-request gedaan wordt via een fork, leidt dit helaas tot een error, zie [Issue #79](https://github.com/MinBZK/Algoritmekader/issues/79). Dit blokkeert de pull-request niet.
>
> We maken gebruik van de tool [pr-preview-action](https://github.com/rossjrw/pr-preview-action) om automatisch previews te maken van een pull-request.
> Dit maakt het mogelijk om de wijzigingen die zijn gedaan in een pull-request al te bekijken in de uiteindelijke omgeving.
> Wanneer er een pull-request gedaan wordt via een fork, leidt dit helaas tot een error, zie [Issue #79](https://github.com/MinBZK/Algoritmekader/issues/79). Dit blokkeert de pull-request niet.

### Hoe we werken op Github
We werken met [Markdown](https://www.markdownguide.org/basic-syntax/) bestanden.
Dit is bestandsformaat voor platte tekstbestanden en wordt door veel verschillende tools ondersteund. Dit maakt het eenvoudig om versiebeheer op het Algoritmekader toe te passen.

Daarnaast maken gebruik van [mkdocs](https://www.mkdocs.org/) en [material for mkdocs](https://squidfunk.github.io/mkdocs-material/) om de informatie op een interactieve wijze inzichtelijk te maken op de website van [het Algoritmekader](https://minbzk.github.io/Algoritmekader/).
We werken met [Markdown](https://www.markdownguide.org/basic-syntax/) bestanden.
Dit is bestandsformaat voor platte tekstbestanden en wordt door veel verschillende tools ondersteund. Dit maakt het eenvoudig om versiebeheer op het Algoritmekader toe te passen.

Daarnaast maken gebruik van [mkdocs](https://www.mkdocs.org/) en [material for mkdocs](https://squidfunk.github.io/mkdocs-material/) om de informatie op een interactieve wijze inzichtelijk te maken op de website van [het Algoritmekader](https://minbzk.github.io/Algoritmekader/).

#### Wil je een nieuwe pagina aanmaken?
In het [mkdocs.yml](https://github.com/MinBZK/Algoritmekader/blob/main/mkdocs.yml) bestand staan de settings voor deze website.

In het [mkdocs.yml](https://github.com/MinBZK/Algoritmekader/blob/main/mkdocs.yml) bestand staan de settings voor deze website.
In principe hoef je hier niets aan aan te passen, maar als je een nieuwe pagina wilt aanmaken kan het nodig zijn om hier een aanpassing in te doen.
Onderdeel van deze settings is namelijk de navigatie voor de site (welke pagina's zijn zichtbaar, en welke pagina's vallen daaronder). Dit staat in de nav: sectie.
Onderdeel van deze settings is namelijk de navigatie voor de site (welke pagina's zijn zichtbaar, en welke pagina's vallen daaronder). Dit staat in de nav: sectie.
Indien je een nieuwe pagina wilt toevoegen, is het vaak nodig deze wijziging ook door te voeren in het [mkdocs.yml](https://github.com/MinBZK/Algoritmekader/blob/main/mkdocs.yml) bestand.

2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -285,4 +285,4 @@ the rights granted in Article 2 of this Licence and protect the covered Source
Code from exclusive appropriation.

All other changes or additions to this Appendix require the production of a new
EUPL version.
EUPL version.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-brightgreen?logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/)

# Algoritmekader
We ontwikkelen het Algoritmekader op een open manier via Github.

Deze repository wordt deployed op [https://minbzk.github.io/Algoritmekader](https://minbzk.github.io/Algoritmekader/).
We ontwikkelen het Algoritmekader op een open manier via Github.

Deze repository wordt deployed op [https://minbzk.github.io/Algoritmekader](https://minbzk.github.io/Algoritmekader/).

### Dit is de Github repository voor het Algoritmekader
In deze repository ontwikkelen wij het Algoritmekader. Boven op deze pagina vind je de bestanden van het Algoritmekader.
De informatie van het algoritmekader wordt uitgewerkt in verschillende markdown bestanden (een bestandsformaat voor platte tekstbestanden).

In deze repository ontwikkelen wij het Algoritmekader. Boven op deze pagina vind je de bestanden van het Algoritmekader.
De informatie van het algoritmekader wordt uitgewerkt in verschillende markdown bestanden (een bestandsformaat voor platte tekstbestanden).
Deze bestanden worden inzichtelijk gemaakt met behulp van [mkdocs](https://www.mkdocs.org/) en [material for mkdocs](https://squidfunk.github.io/mkdocs-material/).

## Hoe kun je bijdragen?
Dat kan op verschillende manieren. Zie onze [Contributing Guidelines](https://github.com/MinBZK/Algoritmekader/blob/main/CONTRIBUTING.md) voor meer uitleg over hoe je kan bijdragen aan het Algoritmekader.

Dat kan op verschillende manieren. Zie onze [Contributing Guidelines](https://github.com/MinBZK/Algoritmekader/blob/main/CONTRIBUTING.md) voor meer uitleg over hoe je kan bijdragen aan het Algoritmekader.

## Vragen?

Maak een [Issue](https://github.com/MinBZK/Algoritmekader/issues) aan op GitHub. Of mail [[email protected]](mailto:[email protected])
6 changes: 2 additions & 4 deletions docs/bouwblokken/conformiteitsbeoordeling/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,12 @@ Hier komt een beschrijving van dit bouwblok.

!!! info "Opmerking"

Dit bouwblok moet nog ontwikkeld worden. Deze pagina is dus nog niet volledig. Op deze pagina vind je mogelijk wel al onderdelen waar we aandacht aan willen besteden in dit bouwblok.

Dit bouwblok moet nog ontwikkeld worden. Deze pagina is dus nog niet volledig. Op deze pagina vind je mogelijk wel al onderdelen waar we aandacht aan willen besteden in dit bouwblok.

## Vereisten

<!-- list_vereisten bouwblok/conformiteitsbeoordeling -->


## Maatregelen

<!-- list_maatregelen bouwblok/conformiteitsbeoordeling -->
<!-- list_maatregelen bouwblok/conformiteitsbeoordeling -->
15 changes: 8 additions & 7 deletions docs/bouwblokken/data/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@ icon: material/database

![data](../../afbeeldingen/bouwblokken/data.jpg "visuele weergave data"){align="right"; width="50%"}

Het ontwikkelen en gebruiken van algoritmes en AI-systemen kan niet gepaard gaan zonder het verwerken van data.
In het geval van AI wordt data gebruikt om het algoritme te trainen, te valideren en te testen.
Wanneer beslissingen worden genomen op basis van de output van een algoritme of AI-systeem, dan wordt deze beslissing ook genomen op basis van de onderliggende data.
Om algoritmes en AI-systemen op een verantwoorde manier toe te passen, dient dus ook de data op een verantwoorde manier gebruikt te worden.
Het ontwikkelen en gebruiken van algoritmes en AI-systemen kan niet gepaard gaan zonder het verwerken van data.
In het geval van AI wordt data gebruikt om het algoritme te trainen, te valideren en te testen.
Wanneer beslissingen worden genomen op basis van de output van een algoritme of AI-systeem, dan wordt deze beslissing ook genomen op basis van de onderliggende data.
Om algoritmes en AI-systemen op een verantwoorde manier toe te passen, dient dus ook de data op een verantwoorde manier gebruikt te worden.

In dit bouwblok werken we uit welke vereisten er zijn voor verantwoord datagebruik, en geven we praktische maatregelen hoe dit ingevuld kan worden binnen overheidsorganisaties.
We zoeken hierbij de aansluiting op bestaande instrumenten, zoals de [Toolbox verantwoord datagebruik](https://realisatieibds.nl/page/view/628d59dd-0755-4c20-8217-d3f26d9d8a5c/toolbox-voor-verantwoord-datagebruik).
In dit bouwblok werken we uit welke vereisten er zijn voor verantwoord datagebruik, en geven we praktische maatregelen hoe dit ingevuld kan worden binnen overheidsorganisaties.
We zoeken hierbij de aansluiting op bestaande instrumenten, zoals de [Toolbox verantwoord datagebruik](https://realisatieibds.nl/page/view/628d59dd-0755-4c20-8217-d3f26d9d8a5c/toolbox-voor-verantwoord-datagebruik).

!!! info "Opmerking"

Dit bouwblok moet nog ontwikkeld worden. Deze pagina is dus nog niet volledig. Op deze pagina vind je mogelijk wel al onderdelen waar we aandacht aan willen besteden in dit bouwblok.
Dit bouwblok moet nog ontwikkeld worden. Deze pagina is dus nog niet volledig. Op deze pagina vind je mogelijk wel al onderdelen waar we aandacht aan willen besteden in dit bouwblok.

## Vereisten

Expand All @@ -27,4 +27,5 @@ We zoeken hierbij de aansluiting op bestaande instrumenten, zoals de [Toolbox ve
<!-- list_maatregelen bouwblok/data -->

## Nuttige informatie

- FAIR data: [GO FAIR Foundation](https://www.gofair.foundation/).
Loading
Loading