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

docs: add openFormulieren update strategy #902

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# OpenFormulieren updates installeren

Om OpenFormulieren soepel te laten functioneren, werken ons Frontend- en Strapi-dashboard nauw samen.
Dit is hoe we het aanpakken:

## SDK-gebruik

We integreren de OpenFormulier SDK met het de [`@open-formulieren/sdk` npm-package](https://www.npmjs.com/package/@open-formulieren/sdk) in de PDC-frontend. Dit stelt ons in staat om updates zelfstandig te beheren, zodat onze frontend altijd voorzien is van de nieuwste functies en verbeteringen.

## API gebruik

Het PDC-Strapi-dashboard maakt gebruik van OpenFormulieren API. Het DevOps-team beheert deze updates, zodat onze backend synchroon blijft met de frontend.

## Coördinatie van updates installeren

Het is belangrijk dat alle teams de volgende updates op elkaar afstemmen. Eventuele wijzigingen in de SDK of API moeten snel worden gecommuniceerd, zodat zowel de frontend als de backend gelijktijdig worden bijgewerkt.

1. Open Forms server
2. Open Forms SDK in de frontend van websites waarin die embedded is.
3. Open Forms SDK in de backend van websites waarin die embedded is.
4. Open Forms REST API calls in het Strapi CMS.
Loading