Skip to content

Commit 8ed99bd

Browse files
authored
790: Broken links on kennisbank (#854)
* docs: replace quote by link * docs: update page about EDA * docs: add docs on how to check links * docs: add linkinator example JSON writeout * dev: ignore linkinator-results.json * docs: update links in docs/leidraad * docs : fix dead links in api-ontwikkeling chapter * docs: update dead links in front-end chapter * docs: update links in /kennisbank/data chapter * docs: update dead links in open-source chapter * docs: update nis1.md * docs: update nis2.mdx * docs: update dead links in /security chapter * build: disable check-links.yml manually * docs: update digitoegankelijk * fix: add changeset
1 parent 8f2b063 commit 8ed99bd

23 files changed

Lines changed: 143 additions & 112 deletions

File tree

.changeset/curly-toes-ask.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
"@developer-overheid-nl/website": minor
3+
---
4+
5+
Updated dead links in all knowledge base chapters. Fixed check-links github
6+
action. Disabled the check-links github action for now since it currently has
7+
too much errors.

.github/workflows/check-links.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ on:
44
pull_request:
55
push:
66
workflow_dispatch:
7-
schedule:
8-
- cron: "0 5 * * *"
7+
# schedule:
8+
# - cron: "0 5 * * *"
99

1010
jobs:
1111
check-links:
@@ -25,7 +25,7 @@ jobs:
2525
- name: Run Linkinator to check links
2626
uses: JustinBeckwith/linkinator-action@f62ba0c110a76effb2ee6022cc6ce4ab161085e3
2727
with:
28-
paths: "build/index.html"
28+
paths: "build"
2929
recurse: true
3030
cleanUrls: true
3131
config: "./linkinator.config.json"

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,3 +135,5 @@ build
135135
# We will use pnpm instead
136136
package-lock.json
137137
.DS_Store
138+
139+
linkinator-results.json

README.md

Lines changed: 40 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,29 @@ Voer eerst de stappen uit zoals beschreven in
5656
pnpm run lint:wcag
5757
```
5858

59+
## Links controleren
60+
61+
De workflow `.github/workflows/check-links.yml` controleert of alle links op de
62+
website nog werken met
63+
[Linkinator](https://github.com/JustinBeckwith/linkinator). Je kan deze check
64+
ook lokaal draaien:
65+
66+
1. Draai `pnpm run build` om de site te builden naar de map `build/`.
67+
2. Draai Linkinator met dezelfde instellingen als de workflow:
68+
69+
```bash
70+
npx linkinator build \
71+
--recurse \
72+
--format JSON \
73+
--clean-urls \
74+
--config ./linkinator.config.json \
75+
--verbosity ERROR \
76+
--timeout 5000 \
77+
> linkinator-results.json
78+
```
79+
80+
Links die bewust overgeslagen moeten worden staan in `linkinator.config.json`.
81+
5982
## Publiceren blogpost
6083

6184
Om een blog te publiceren die in draft staat volg je de volgende stappen:
@@ -68,10 +91,20 @@ Om een blog te publiceren die in draft staat volg je de volgende stappen:
6891

6992
## Changelog
7093

71-
Nieuwe features, bugfixes en andere wijzigingen worden bijgehouden in de changelog. Hierin vermelden wat er veranderd, verbeterd of toegevoegd is.
72-
Via [Changesets] (`pnpm changeset`) kan er een changelog entry worden aangemaakt. De Changesets bot en workflow maakt automatisch een pull request aan die de verschillende changelog entries samenvoegt. Deze pull request kan worden gemerged voor elke release.
73-
74-
Ondanks dat er geen software package wordt gepubliceerd, gebruiken we de changelog om bij te houden wat er veranderd is in de website. De semver gebruikt in de changelog heeft geen technische betekenis, maar geeft aan of een verandering een nieuwe feature, bijvoorbeeld een nieuw blog, is (minor), een bugfix (patch) of een "breaking" change (major). Voorbeelden van een breaking change zijn bijvoorbeeld het verwijderen van een artikel of het aanpassen van de URL van een artikel.
94+
Nieuwe features, bugfixes en andere wijzigingen worden bijgehouden in de
95+
changelog. Hierin vermelden wat er veranderd, verbeterd of toegevoegd is.
96+
Via [Changesets] (`pnpm changeset`) kan er een changelog entry worden
97+
aangemaakt. De Changesets bot en workflow maakt automatisch een pull request aan
98+
die de verschillende changelog entries samenvoegt. Deze pull request kan worden
99+
gemerged voor elke release.
100+
101+
Ondanks dat er geen software package wordt gepubliceerd, gebruiken we de
102+
changelog om bij te houden wat er veranderd is in de website. De semver gebruikt
103+
in de changelog heeft geen technische betekenis, maar geeft aan of een
104+
verandering een nieuwe feature, bijvoorbeeld een nieuw blog, is (minor), een
105+
bugfix (patch) of een "breaking" change (major). Voorbeelden van een breaking
106+
change zijn bijvoorbeeld het verwijderen van een artikel of het aanpassen van de
107+
URL van een artikel.
75108

76109
### Hoe maak ik een changelog entry aan?
77110

@@ -84,7 +117,8 @@ Ondanks dat er geen software package wordt gepubliceerd, gebruiken we de changel
84117
### Release nieuwe versie van de website
85118

86119
1. Merge de pull request van de Changesets bot.
87-
2. Merge de pull request in de `don-infra` repository, zie de beschrijving hieronder.
120+
2. Merge de pull request in de `don-infra` repository, zie de beschrijving
121+
hieronder.
88122

89123
## Deployen
90124

@@ -146,4 +180,4 @@ Een contribution of pull request leidt niet automatisch tot een deployment.
146180
ook `INFRA_REPO` aan te passen. Daardoor is dit pad in de praktijk bedoeld
147181
voor maintainers of contributors met een branch in deze repository.
148182

149-
[Changesets]:https://github.com/changesets/changesets
183+
[Changesets]: https://github.com/changesets/changesets

docs/api-ontwikkeling/architectuur/eda.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ content_type: architectuur
33
tags: [adr, api, eda]
44
---
55

6-
import { Blockquote } from "@rijkshuisstijl-community/components-react";
7-
86
# Event Driven Architecture
97

108
De digitale samenleving vraagt om snelheid en actualiteit. Burgers willen live
@@ -60,8 +58,8 @@ Afhankelijk van je use case kies je een real-time patroon:
6058
Een goed ontworpen event-driven API kent dezelfde discipline als een REST-API:
6159

6260
- Gebruik rijke payloads zodat consumers niet hoeven na te vragen.
63-
- Pas de [Cloudevents](../standaarden/cloudevents.md) standaard toe op basis van het NL
64-
profiel.
61+
- Pas de [Cloudevents](../standaarden/cloudevents.md) standaard toe op basis van
62+
het NL profiel.
6563
- Ontwerp een duidelijke event-taxonomie met logische naamgeving.
6664
- Houd rekening met "idempotency" voor dubbele events.
6765
- Voorzie in subscription mechanismen en foutafhandeling.
@@ -91,9 +89,9 @@ je ervaringen via developer.overheid.nl of neem deel aan het
9189
en deel onderling ervaringen rond de NL API Strategie en event oriëntatie. Samen
9290
maken we API’s slimmer, robuuster en toekomstbestendig.
9391

94-
<Blockquote
95-
variation="pink-background"
96-
attribution="- Developer.overheid.nl/blog -"
97-
>
98-
Lees ook het Blog "De toekomstige van de Overheid is Event Driven" op [Developer.overheid.nl/blog](https://developer.overheid.nl/blog)
99-
</Blockquote>
92+
## Verder lezen
93+
94+
<Link href="/blog/2026/03/06/event-driven">
95+
Blog: De toekomst van de overheid is event-driven
96+
<Icon icon="pijl-naar-rechts" />
97+
</Link>

docs/api-ontwikkeling/architectuur/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,6 @@ modulaire overheidsinfrastructuur.
149149
- [KP-APIs GitHub](https://github.com/Geonovum/KP-APIs)
150150
- [API Design Rules (ADR)](https://gitdocumentatie.logius.nl/publicatie/api/adr/)
151151
- [NL API Strategie – Architectuur](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Architectuur/)
152-
- [API Management en Beveiliging – Developer Overheid](https://developer.overheid.nl/apis/beveiliging/)
153152

154153
## Onderwerpen
155154

docs/api-ontwikkeling/standaarden/cloudevents.md

Lines changed: 10 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ tags: [adr, api, eda, cloudevents]
88
## Van intake tot verplichte standaard
99

1010
CloudEvents is een internationale standaard voor het uniform beschrijven van
11-
events in [eventgedreven architecturen](../architectuur/eda.md). Dankzij deze standaard kunnen
12-
applicaties eenvoudiger informatie uitwisselen over gebeurtenissen (bijvoorbeeld
13-
een adreswijziging of een vergunningaanvraag). In Nederland wordt CloudEvents nu
14-
voorzien van een nationaal profiel: het
15-
[**NL GOV profile for CloudEvents**](https://gitdocumentatie.logius.nl/publicatie/notificatieservices/CloudEvents-NL/).
11+
events in [eventgedreven architecturen](../architectuur/eda.md). Dankzij deze
12+
standaard kunnen applicaties eenvoudiger informatie uitwisselen over
13+
gebeurtenissen (bijvoorbeeld een adreswijziging of een vergunningaanvraag). In
14+
Nederland wordt CloudEvents nu voorzien van een nationaal profiel: het
15+
[**NL GOV profile for CloudEvents**](https://gitdocumentatie.logius.nl/publicatie/notificatieservices/cloudevents-nl/1.1/).
1616

1717
---
1818

@@ -26,13 +26,15 @@ voorzien van een nationaal profiel: het
2626
Het Forum Standaardisatie stemde in met het intakeadvies om het _"NL GOV
2727
profile for CloudEvents"_ in procedure te nemen voor plaatsing op de lijst met
2828
verplichte standaarden (“Pas toe of leg uit”).
29-
Bron: [intakeadvies NL GOV profile for CloudEvents (PDF)](https://www.forumstandaardisatie.nl/sites/default/files/BFS/3-lijsten/standaarden/cloudevents/20241204-intakeadvies-NL-GOV-profile-for-CloudEvents.pdf).
29+
Bron:
30+
[intakeadvies NL GOV profile for CloudEvents (PDF)](https://www.forumstandaardisatie.nl/sites/default/files/BFS/3-lijsten/standaarden/cloudevents/20241204-intakeadvies-NL-GOV-profile-for-CloudEvents.pdf).
3031

3132
- **19 juni 2025 – Expertadvies**
3233
De expertgroep adviseerde positief over opname van de standaard. Het profiel
3334
sluit nauw aan op internationale CloudEvents-specificaties, maar maakt ze
3435
concreet toepasbaar binnen de Nederlandse overheid.
35-
Bron: [expertadvies NL GOV profile for CloudEvents (PDF)](https://www.forumstandaardisatie.nl/sites/default/files/BFS/3-lijsten/standaarden/cloudevents/20250619-Expertadvies-NL-GOV-profile-for-CloudEvents.pdf).
36+
Bron:
37+
[expertadvies NL GOV profile for CloudEvents (PDF)](https://www.forumstandaardisatie.nl/sites/default/files/BFS/3-lijsten/standaarden/cloudevents/20250619-Expertadvies-NL-GOV-profile-for-CloudEvents.pdf).
3638

3739
- **25 september 2025 – Forumadvies**
3840
Het Forum Standaardisatie heeft ingestemd met het advies aan het
@@ -74,23 +76,6 @@ systemen en sectoren. Het NL GOV profiel specificeert onder meer:
7476
}
7577
```
7678

77-
De technische specificatie is beschikbaar via Logius: -
78-
[CloudEvents NL – technische documentatie](https://gitdocumentatie.logius.nl/publicatie/notificatieservices/CloudEvents-NL/).
79-
Het
80-
voorbeeld en de toelichting daarop zijn beschikbaar op
81-
[gitdocumentatie.logius.nl/publicatie/notificatieservices/CloudEvents-NL/#example](https://gitdocumentatie.logius.nl/publicatie/notificatieservices/CloudEvents-NL/#example).
82-
83-
Naast het Nederlandse profiel zijn ook een drietal handreikingen gemaakt die
84-
toelichten hoe het NL GOV profiel is toe te passen bij gebruik van het:
85-
86-
- [JSON gegevensformaat](https://github.com/Logius-standaarden/CloudEvents-NL-Guidelines/blob/develop//NL-GOV-Guideline-for-CloudEvents-JSON.md)
87-
- [HTTP transportprotocol](https://github.com/Logius-standaarden/CloudEvents-NL-Guidelines/blob/develop/NL-GOV-Guideline-for-CloudEvents-HTTP.md)
88-
- [Webhook interactiepatroon](https://github.com/Logius-standaarden/CloudEvents-NL-Guidelines/blob/develop//NL-GOV-Guideline-for-CloudEvents-Webhook.md).
89-
90-
> Deze handreikingen verwijzen naar door de Serverless Working Group ontwikkelde
91-
> specificaties. Doel daarvan is om verdergaande standaardisatie te
92-
> bewerkstelligen en interoperabiliteit te vergroten.
93-
9479
## Waarom belangrijk?
9580

9681
Het gebruik van CloudEvents en het NL GOV profiel helpt de overheid om:
@@ -104,6 +89,6 @@ Het gebruik van CloudEvents en het NL GOV profiel helpt de overheid om:
10489
## Meer informatie
10590

10691
- [NL GOV profile for CloudEvents – Forum Standaardisatie](https://www.forumstandaardisatie.nl/open-standaarden/nl-gov-profile-cloudevents)
107-
- [CloudEvents NL – Logius documentatie](https://gitdocumentatie.logius.nl/publicatie/notificatieservices/CloudEvents-NL/)
92+
- [CloudEvents NL – Logius documentatie](https://gitdocumentatie.logius.nl/publicatie/notificatieservices/cloudevents-nl/1.1/)
10893
- [CloudEvents NL - Guidelines for HTTP, JSON & Webhooks](https://gitdocumentatie.logius.nl/publicatie/notificatieservices/guidelines/)
10994
- [De internationale specificatie en documentatie van Cloudevents](https://cloudevents.io/)

docs/api-ontwikkeling/tutorials/bouw-een-api/4-valideer-oas.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,7 @@ versienummer en we bezig zijn met versie 1.0 van de API, plakken we `/v1`
4444
erachter. De waarde van de server `url` wordt dus:
4545
`https://api.bieren.nepdomein/v1`. Zodra je dit hebt aangepast meldt de checker:
4646

47-
> [https://logius-standaarden.github.io/API-Design-Rules/2.0] No violations
48-
> found.
47+
> [https://logius-standaarden.github.io/API-Design-Rules/] No violations found.
4948
5049
<details>
5150
<summary>De spec zou er op dit moment zo uit moeten zien</summary>

docs/devops/standaarden/fsc/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Wil je direct met FSC aan de slag dan kan je de referentie implementatie
2323
## Standaardisatie in gegevensuitwisseling
2424

2525
Volgens het principe
26-
[Data bij de Bron](https://www.digitaleoverheid.nl/data-bij-de-bron) moeten
26+
[Data bij de Bron](https://www.digitaleoverheid.nl/overzicht-van-alle-onderwerpen/data/data-bij-de-bron/) moeten
2727
organisaties die verantwoordelijk zijn voor data deze op een bruikbare manier
2828
beschikbaar stellen. Dit principe gaat er voor zorgen dat er veel koppelingen
2929
zullen ontstaan tussen afnemers en bronnen. Om te voorkomen dat er een

docs/front-end/design-systems/nl-design-system/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ van het Design System van gemeente Utrecht.
118118

119119
## Rijkshuisstijl Community
120120

121-
De [Rijkshuisstijl Community](https://rijkshuisstijl.community/) is een
121+
De [Rijkshuisstijl Community](https://www.rijkshuisstijl-community.nl/) is een
122122
opensource community die een **concrete implementatie** van de Rijkshuisstijl
123123
heeft ontwikkeld als design system componenten. Een van de vele design systemen
124124
die is aangesloten bij het NL Design System framework.

0 commit comments

Comments
 (0)