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

eerste versie van vereisten via script #77

Merged
merged 31 commits into from
Apr 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
0af505d
eerste versie van vereisten via script
ruthkoole Apr 2, 2024
30a0cc9
verwijderen leeg bestand
ruthkoole Apr 2, 2024
e1fde9f
update requirement.txt
ruthkoole Apr 2, 2024
448cba2
verwijderen bestanden met nog onvolledige info
ruthkoole Apr 2, 2024
368f100
fix broken links
ruthkoole Apr 3, 2024
d990af5
verwijderen prints en toevoegen navigatie in footer
ruthkoole Apr 3, 2024
c3113c0
Update index.md
BartdeVisser Apr 4, 2024
3d09529
Update index.md
BartdeVisser Apr 4, 2024
6b1d4a1
Update index.md
BartdeVisser Apr 4, 2024
6137919
Update index.md
BartdeVisser Apr 4, 2024
339bb03
toevoegen van algemene teksten: home, maatregelen, vereisten, rollen,…
ruthkoole Apr 10, 2024
a4aa466
Update index.md
BartdeVisser Apr 10, 2024
092b85e
toevoegen algemene tekst over instrumenten
ruthkoole Apr 10, 2024
2ef77b1
Merge branch 'vereisten-toevoegen' of https://github.com/MinBZK/Algor…
ruthkoole Apr 10, 2024
fc873fd
Update index.md
BartdeVisser Apr 10, 2024
9aed70d
Update index.md
BartdeVisser Apr 10, 2024
412e8d6
Update archiefwet.md
BartdeVisser Apr 10, 2024
550625e
Update index.md
BartdeVisser Apr 10, 2024
304313a
Update index.md
BartdeVisser Apr 10, 2024
0c13114
toevoegen van opmerkingen op bouwblokken pagina en contributing guide…
ruthkoole Apr 10, 2024
91abe4c
toevoegen CONTRIBUTING.md
ruthkoole Apr 10, 2024
1ec99d9
toevoegen toelichting over mkdocs.yml
ruthkoole Apr 10, 2024
80c07ea
Merge branch 'vereisten-toevoegen' of https://github.com/MinBZK/Algor…
ruthkoole Apr 10, 2024
25b6660
update readme met verwijzing naar contributing guidelines
ruthkoole Apr 10, 2024
46ce0fe
fix typo
ruthkoole Apr 10, 2024
eebf862
aanpassen vereisten nav review
ruthkoole Apr 11, 2024
e292c53
aanpassen hoofdlettergebruik in toelichting van vereisten
ruthkoole Apr 11, 2024
48e85c0
kleine wijziging op inkoop pagina en overhetalgoritmekader
ruthkoole Apr 11, 2024
ca498a7
Merge branch 'main' into vereisten-toevoegen
ruthkoole Apr 11, 2024
ee0401d
Merge branch 'vereisten-toevoegen' of https://github.com/MinBZK/Algor…
ruthkoole Apr 11, 2024
1618ab5
fix typo
ruthkoole Apr 11, 2024
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
7 changes: 6 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# build files
site
.venv/
.venv/

# python cache
**/__pycache__/**

src/overrides/hooks/create_vereisten.py
118 changes: 118 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
# Bijdragen aan het Algoritmekader

Allereerst, bedankt dat je de tijd hebt genomen om een bijdrage te leveren! ❤️

We waarderen alle soorten bijdragen enorm. Zie die [Inhoudsopgave](#inhoudsopgave) voor verschillende manieren waarop je kan bijdragen aan het Algoritmekader.
Zorg ervoor dat je de relevante hoofdstukken even leest voordat je een bijdrage levert.
Het zal het voor het team van het Algoritmekader een stuk makkelijker maken en de ervaring voor alle betrokkenen soepeler laten verlopen.
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.
> 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.

## Inhoudsopgave

- [Code of Conduct](#code-of-conduct)
- [Ik heb een vraag](#ik-heb-een-vraag)
- [Ik wil iets bijdragen](#ik-wil-iets-bijdragen)
- [Ik wil een fout of bug melden](#ik-wil-een-fout--bug-melden)
- [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
aan **[[email protected]](mailto:[email protected])**.

## Ik heb een vraag

### 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.

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.
3. Anderen kunnen nu opmerkingen toevoegen aan jouw issue.
4. Het team van het Algoritmekader zal deze issue labelen als `question` en pakt jouw issue zo snel mogelijk op. Mogelijk neemt het team van het Algoritmekader contact op voor een verduidelijking of een oplossing.

### Stel een vraag via mail

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.

> #### 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.

### 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.

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.
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.

#### Voordat je een suggestie gaat maken

- 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.

#### Een issue 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.

#### Een pull-request maken
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).

> 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.

### 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/).

#### 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 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.
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.

42 changes: 10 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,17 @@
# Algoritmekader
We ontwikkelen het Algoritmekader op een open manier via Github. Bekijk [de ontwikkelomgeving van het Algoritmekader](https://minbzk.github.io/Algoritmekader/).

**Dit is de Github repo voor het Algoritmekader**
Op deze pagina lees je hoe je kunt bijdragen aan de ontwikkeling van het Algoritmekader. Boven deze tekst vind je de bestanden voor het kader. We gebruiken Markdown en Mkdocs. Meer daarover lees je onder punt 5.

## Hoe kun je bijdragen?
Dat kan op verschillende manieren. Kijk welke manier jou het beste past.
1 t/m 5 zijn geschikte manieren voor gebruikers die nog niet zo bekend zijn met Github.
5 en 6 Geven input voor ervaren Github gebruikers, die op de voor hen bekende manieren een bijdrage kunnen leveren.
[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-brightgreen?logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/)

### 1. Sluit je aan bij een werkgroep ###
Regelmatig starten er nieuwe werkgroepen op bouwblokken of thema's. Deelname kost gemiddeld 3-4 uur per week. Wil je op een van de onderwerpen meewerken? Stuur dan een bericht naar [email protected] 

### 2. Neem deel aan een sprintreview ###
We werken in sprints van 3 of 4 weken, gevolgd door een open online review. 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.

### 3. Stuur een e-mail naar [[email protected]](mailto:[email protected])
1. Stuur ons je vraag of opmerking, met een duidelijke toelichting. We reageren binnen enkele dagen op je mail.
2. Het team van het Algoritmekader pakt jouw issue op en neemt mogelijk contact op voor verduidelijking of oplossing.
# Algoritmekader
We ontwikkelen het Algoritmekader op een open manier via Github.

### 4. Maak een issue aan
1. Via [Issues](https://github.com/MinBZK/Algoritmekader/issues) kan je bestaande issues bekijken of een nieuwe aanmaken.
2. Gebruik daarvoor de knop `new issue`.
3. Schrijf je vraag of opmerking is en geef een heldere toelichting.
4. Anderen kunnen comments toevoegen aan jouw issue.
5. Het team van het Algoritmekader pakt jouw issue op en neemt mogelijk contact op voor verduidelijking of oplossing.
Deze repository wordt deployed op [https://minbzk.github.io/Algoritmekader](https://minbzk.github.io/Algoritmekader/).

### 5. Stuur een *pull request*
Kun je niet uit de voeten met de issues? Bijvoorbeeld omdat je verschillende wijzigingsvoorstellen wilt doen. We houden het aantal collaborators zeer beperkt. Gebruik bijvoorbeeld [Fork en doe 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).
### 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).
Deze bestanden worden inzichtelijk gemaakt met behulp van [mkdocs](https://www.mkdocs.org/) en [material for mkdocs](https://squidfunk.github.io/mkdocs-material/).

We werken met [Markdown](https://www.markdownguide.org/basic-syntax/) bestanden. Dit bestandsformaat wordt door veel verschillende tools ondersteund, en maakt het eenvoudig versiebeheer toe te passen. Tijdens de ontwikkelfase gebruiken we [mkdocs](https://www.mkdocs.org/) en [material for mkdocs](https://squidfunk.github.io/mkdocs-material/) voor de presentatie op [de ontwikkelomgeving](https://minbzk.github.io/Algoritmekader/). Zo werken we direct aan de interactiviteit en flexibiliteit van het kader. Uiteindelijk landt het Algoritmekader op een bestaande overheidswebsite zoals [Digitale Overheid](https://www.digitaleoverheid.nl/).

### 6. Iets aanpassen in de navigatie van de website?
We maken gebruik van [mkdocs](https://www.mkdocs.org/) en [material for mkdocs](https://squidfunk.github.io/mkdocs-material/) om de documentatie inzichtelijk te maken op een website. In het bestand [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.
Onderdeel van deze settings is de navigatie voor de site (welke kopjes zijn zichtbaar, en welke kopjes vallen daaronder). Dit staat in de `nav:` sectie. Indien je een kopje wilt toevoegen, kan dat in deze sectie.
## Hoe kun je bijdragen?
Dat kan op verschillende manieren. Zie onze [Contributing Guidelines](https://github.com/MinBZK/Algoritmekader/blob/vereisten-toevoegen/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])
73 changes: 0 additions & 73 deletions docs/bouwblokken/conformiteitsbeoordeling/audit.md

This file was deleted.

17 changes: 16 additions & 1 deletion docs/bouwblokken/conformiteitsbeoordeling/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,21 @@
---
title: Conformiteitsbeoordeling
summary: Hier staat een korte samenvatting over dit onderwerp
icon: material/check-circle
---

Hier komt een beschrijving van de welke bouwblokken er zijn
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.


## Vereisten

<!-- list_vereisten bouwblok/conformiteitsbeoordeling -->


## Maatregelen

<!-- list_maatregelen bouwblok/conformiteitsbeoordeling -->
Loading