docs: add openFormulieren update strategy #902
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Codecov ReportAll modified and coverable lines are covered by tests ✅ |
Robbert
reviewed
Sep 26, 2024
| @@ -0,0 +1,16 @@ | |||
| # OpenFormulieren bijwerkstrategie | |||
There was a problem hiding this comment.
Suggested change
| # OpenFormulieren bijwerkstrategie | |
| # OpenFormulieren updates installeren |
|
|
||
| ## SDK-gebruik | ||
|
|
||
| We integreren de OpenFormulier SDK als NPM pakket 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. |
There was a problem hiding this comment.
Suggested change
| We integreren de OpenFormulier SDK als NPM pakket 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. | |
| 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. |
There was a problem hiding this comment.
"Frontend" in "pdc-frontend" is eigenlijk een beetje misleidend, omdat Next.js ook backend code heeft die relevant is voor Open Forms.
|
|
||
| ## API gebruik | ||
|
|
||
| Het PDC-Strapi-dashboard maakt gebruik van OpenFormulieren API. Het DevOps-team beheert deze updates, zodat onze backend synchroon blijft met de fronted. |
There was a problem hiding this comment.
Handig om even precies te noemen welke APIs, door middel van het path-gedeelte van de URLs, inclusief het versienummer.
|
|
||
| Het PDC-Strapi-dashboard maakt gebruik van OpenFormulieren API. Het DevOps-team beheert deze updates, zodat onze backend synchroon blijft met de fronted. | ||
|
|
||
| ## Teamcoördinatie |
There was a problem hiding this comment.
Suggested change
| ## Teamcoördinatie | |
| ## Coördinatie van updates installeren |
|
|
||
| ## API gebruik | ||
|
|
||
| Het PDC-Strapi-dashboard maakt gebruik van OpenFormulieren API. Het DevOps-team beheert deze updates, zodat onze backend synchroon blijft met de fronted. |
There was a problem hiding this comment.
Suggested change
| Het PDC-Strapi-dashboard maakt gebruik van OpenFormulieren API. Het DevOps-team beheert deze updates, zodat onze backend synchroon blijft met de fronted. | |
| Het PDC-Strapi-dashboard maakt gebruik van OpenFormulieren API. Het DevOps-team beheert deze updates, zodat onze backend synchroon blijft met de frontend. |
|
|
||
| ## API gebruik | ||
|
|
||
| Het PDC-Strapi-dashboard maakt gebruik van OpenFormulieren API. Het DevOps-team beheert deze updates, zodat onze backend synchroon blijft met de fronted. |
There was a problem hiding this comment.
Ik zou iets toevoegen over dat als de APIs geen breaking changes hebben, het in theorie niet nodig is om deze update te coördineren, maar dat het wel best practice is.
|
|
||
| ## Teamcoördinatie | ||
|
|
||
| Het is essentieel dat beide teams hun updates op elkaar afstemmen. Eventuele wijzegingen in de SDK of API moeten snel worden gecommuniceerd, zodat zowel de frontend als de backend gelijktijdig worden bijgewerkt. |
There was a problem hiding this comment.
Suggested change
| Het is essentieel dat beide teams hun updates op elkaar afstemmen. Eventuele wijzegingen in de SDK of API moeten snel worden gecommuniceerd, zodat zowel de frontend als de backend gelijktijdig worden bijgewerkt. | |
| 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 | |
| 1. Open Forms SDK in de frontend van websites waarin die embedded is. | |
| 1. Open Forms SDK in de backend van websites waarin die embedded is. | |
| 1. Open Forms REST API calls in het Strapi CMS. |
AliKdhim87
force-pushed
the
add-update-openforms-section-to-docs-websiete
branch
from
7791a15 to
9149127
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.