Merge branch 'docupdate-integratie' of github.com:ConductionNL/woo-we…

…bsite-template into docupdate-integratie

docs/Configuratie.md

@@ -53,7 +53,7 @@ Daarnaast is het mogelijk om bijlagen van publicaties te clusteren aan de hand v
 
 ## Categorieën
 
-Hoewel we er vanuit gaan dat categorieën voldoen aan de onder [Algemene inrichting zaaksysteem]() vermelde kenmerken voor `woo_categorie` is het technisch mogelijk voor organisaties om eigen categorieën te hanteren. Het toevoegen van een eigen categorie (e.g. algoritme's of dataset) leidt er automatisch toe dat deze in de voorkant wordt opgenomen in de `onderwerpen` lijst (mits er ten minimale één publicatietype van deze categorie gepubliceerd is). Deze toegevoegde categorie en publicaties daarin worden echter **NIET** doorgegeven aan de landelijke index van KOOP.
+Hoewel we er vanuit gaan dat categorieën voldoen aan de onder [Algemene inrichting zaaksysteem]() vermelde kenmerken voor `woo_categorie` is het technisch mogelijk voor organisaties om eigen categorieën te hanteren. Het toevoegen van een eigen categorie (e.g. algoritmes of dataset) leidt er automatisch toe dat deze in de voorkant wordt opgenomen in de `onderwerpen` lijst (mits er ten minimale één publicatietype van deze categorie gepubliceerd is). Deze toegevoegde categorie en publicaties daarin worden echter **NIET** doorgegeven aan de landelijke index van KOOP.
 
 ## Bijlagen
 

docs/Installatie.md

@@ -64,12 +64,14 @@ Configuratie vindt plaats via environment (env) waardes. In het geval van een se
 Voor de backend zijn twee opties beschikbaar. In beide gevallen moet de resulterende URL worden opgenomen onder `API_BASE_URL` in de frontend-configuratie.
 
 ### Open Webconcept met Open Woo en Open Convenanten Plugin
-In dit geval koppel je de react frontend rechtstreek op een wordpress installatie, dat betekend dat alle publicaties handmatig moeten worden geupload.
+
+In dit geval koppel je de React frontend rechtstreeks op een WordPress installatie, dat betekent dat alle publicaties handmatig moeten worden geüpload.
 
 Volg de installatiehandleiding op [https://github.com/OpenWebconcept/plugin-openwoo](https://github.com/OpenWebconcept/plugin-openwoo) en op [https://github.com/OpenWebconcept/plugin-openconvenanten](https://github.com/OpenWebconcept/plugin-openconvenanten).
 
 ### Common Gateway met Open Woo Plugin
-In dit geval koppel je de react frontend op een gatewat installatie, dat betekend dat alle publicaties automatisch worden opgehaald uit bestaande bronnen.
+
+In dit geval koppel je de React frontend op een gateway installatie, dat betekent dat alle publicaties automatisch worden opgehaald uit bestaande bronnen
 
 Volg de installatiehandleiding op [Woo Bundle](https://github.com/ConductionNL/WooBundle/tree/main).
 

docs/KoopHulp.md

@@ -1,37 +1,36 @@
 # Koop Hulp(je)
 
-Vanuit de gemeente Buren is koophulpje.nl opgezet. Het doel van koophulpje is het doen van een proof of concept (poc) met de OpenWoo.app en het stellen van integrale zoek vragen aan de hand van het federale data stelsel (FSC) en API's.
+Vanuit de gemeente Buren is Koophulpje.nl opgezet. Het doel van Koophulpje is het doen van een proof of concept (poc) met de OpenWoo.app en het stellen van integrale zoek vragen aan de hand van het federale data stelsel (FSC) en API's.
 
 ## Voorgeschiedenis
+
 asd
 
-## These
-- Het uitvragen van informatie via API's is gemakenlijker te integreren dan sitemap.xml
+## Voordelen
+
+- Het uitvragen van informatie via API's is gemakkelijker te integreren dan sitemap.xml
 - Het uitvragen van informatie via API's maakt de sitemap.xml overbodig
 - Het federaliseren van de API's maakt een index onnodig
 
-## Opzet 
-- Koophulpje.nl is een 'plate' react pagina, ze beschickt niet over een eigen server maar maakt direct gebruikt van één API
+## Opzet
+
+- Koophulpje.nl is een 'platte' React pagina, ze beschikt niet over een eigen server, maar maakt direct gebruikt van één API
 - Deze API bevat de gegevens van meerdere gemeenten aan de hand van federale bevraging
-- Ter vergelijking creëren we ook sitemap en robot bestanden voor dezelfde gemeenten t.b.v van de door KOOP voorgestelde haverster
+- Ter vergelijking creëren we ook sitemap en robot bestanden voor dezelfde gemeenten t.b.v van de door KOOP voorgestelde harverster
 
 ## Bevindingen
 
-Dataveiligheid: Tijdens vroege testen kwam snel naar voren dat het via API de bron bevragen ipv het opbouwen van een index een databeiligheids verbeteringen opleverdere. Foutieve test data kon snel worden verwijderd en was na verwijdering in het bron systeem geen onderdeel meer van het federale netwerk en daardoor nietmeer vindbaar via koophulpje.
-Hoewel dit bij het testen vooral fijn was, levert het bij daad werkenlijke productie gang een sterk voordeel op. Het stelt organisaties in staat om gegevens terug te treken. Bijvoorbeeld bij het perongeluk publiceren van persoons gegevens kunnen de gegevens onmiddenlijk worden terug getrokken (ipv dat er moet worden gewacht op de volgende keer data de harvester langs komt)
-
-Schaalbaarheid: Het generen van sitemap xml bestanden aan de hand van grotere datasets (1000+) blijkt intensief te zijn 
+Dataveiligheid: Tijdens vroege testen kwam snel naar voren dat het via API de bron bevragen in plaats van het opbouwen van een index een databeveiligheidsverbeteringen opleverde. Foutieve test data kon snel worden verwijderd en was na verwijdering in het bronsysteem geen onderdeel meer van het federale netwerk en daardoor niet meer vindbaar via Koophulpje.
+Hoewel dit bij het testen vooral fijn was, levert het bij daadwerkelijke productie gang een sterk voordeel op. Het stelt organisaties in staat om gegevens terug te trekken. Bijvoorbeeld bij het per ongeluk publiceren van persoonsgegevens kunnen de gegevens onmiddellijk worden teruggetrokken (i.p.v. dat er moet worden gewacht op de volgende keer data de harvester langs komt).
 
-Belasting en kosten: Het genereren van grote sitemap bestanden is server intensief, het confronteerd de publicerende overheid daarmee met realtief hoge kosten. We vermeoden dat dit ook geld aan de kant van de harvester  
+Schaalbaarheid: Het generen van sitemap.xml-bestanden aan de hand van grotere datasets (1000+) blijkt intensief te zijn
 
-Actualitiet: Doordat de sitemap xml bestanden groot zijn blijkt het niet uitvoerbaar om ze bij elke wijziging bij te werken (bijvoorbeeld toegekende vergunning of afgeronde zaak) ipv daarvan worden ze snachts gegenereerd. Dit betekend dat het koppelvlak per defintie achterloopt.
+Belasting en kosten: Het genereren van grote sitemap bestanden is server intensief, het confronteert de publicerende overheid daarmee met relatief hoge kosten. We vermoeden dat dit ook geld aan de kant van de harvester.  
 
+Actualiteit: Doordat de sitemap xml bestanden groot zijn blijkt het niet uitvoerbaar om ze bij elke wijziging bij te werken (bijvoorbeeld toegekende vergunning of afgeronde zaak) ipv daarvan worden ze 's nachts gegenereerd. Dit betekent dat het koppelvlak per definitie achterloopt.
 
-We interpeteren de WOO als alle niet vertrouwelijke gegevens moeten pro-actief openbaar worden gemaakt. Door gebruik te maken van API's in plaats van sitemap xml bestanden zorgen we dat de gegevens alleen worden verstuurd op het moment dat ze worden opgevraagd. Dat vergroot het data verkeer bij gebruikt maar voorkomt data verkeer vooraf. Tijdens de vergelijking 
+We interpreteren de WOO als alle niet vertrouwelijke gegevens moeten pro-actief openbaar worden gemaakt. Door gebruik te maken van API's in plaats van sitemap xml bestanden zorgen we dat de gegevens alleen worden verstuurd op het moment dat ze worden opgevraagd. Dat vergroot het dataverkeer bij gebruik, maar voorkomt dataverkeer vooraf.
 
 ## Conclusie
 
 De voorgestelde oplossing van Sitemap.xml bestanden lijkt in de praktijk onveiliger, duurder en minder actueel dan het inzetten van een API.
-
-
-

docs/Productie.md

@@ -1,44 +1,47 @@
 # In productie nemen
 
-Het in productie nemen van de Open WOO App voor uw organisatie is makkelijker dan u wellicht denkt. Hieronder vindt u de stappen die u moet volgen om succesvol over te gaan naar de productiefase.
+Het in productie nemen van OpenWoo.app voor uw organisatie is makkelijker dan u wellicht denkt. Hieronder vindt u de stappen die u moet volgen om succesvol over te gaan naar de productiefase.
 
-- (optioneel) Kies een [leverancier](https://openwoo.app/pages/Documentatie/Kosten) om de OpenWOO App bij af te nemen. Of implementeer hem zelfstandig.
-- Versamel van te voren alle benodigde informatie
-- Vraag tijdig een PKI certificaat en DNS wijzig bij uw ICT leveranciers
-- Zorg dat u tijd beschikbaar hebt voor het grondig doortesten van de keten aan de hand van de test senario's
+- (optioneel) Kies een [leverancier](https://openwoo.app/pages/Documentatie/Kosten) om de OpenWoo.app bij af te nemen. Of implementeer hem zelfstandig.
+- Verzamel van tevoren alle benodigde informatie
+- Vraag tijdig een PKI-certificaat en DNS wijziginging aan bij uw ICT-leverancier(s)
+- Zorg dat u tijd beschikbaar hebt voor het grondig doortesten van de keten aan de hand van de testscenario's
 
-Als u de OpenWOO APP zelfstandig instaleerd zult u de [acties voor leverancier](#acties-voor-leverancier) uiteraard zelf moeten uitvoeren.
+Als u de OpenWOO APP zelfstandig installeerd zult u de [acties voor leverancier](#acties-voor-leverancier) uiteraard zelf moeten uitvoeren.
 
 ## Benodigde informatie voor de vormgeving
-Om de vormgeving van de OpenWOO-app aan te passen aan uw organisatie, heeft uw leverancier of u de volgende informatie nodig:
+
+Om de vormgeving van OpenWoo.app aan te passen aan uw organisatie, heeft uw leverancier of u de volgende informatie nodig:
 
 - Logo in vector formaat (e.g. .svg, .eps of .ai)
-- Huisstijl handboek of webstie die als voorbeeld gebruikt kan worden
-- Contact gegevens (naam, email adres, telefoon nummer en functie) van een medewerker die eventueele vragen over de huisstijl kan beantwoorden.
+- Huisstijl handboek of website die als voorbeeld gebruikt kan worden
+- Contactgegevens (naam, email adres, telefoonnummer en functie) van een medewerker die eventuele vragen over de huisstijl kan beantwoorden.
 
-Om te beoordelen of uw organsatie NL Design tokens moet maken of aanpassen kunt u het [landelijke overicht van design tokens](https://github.com/nl-design-system/themes/tree/main/proprietary) raadplegen.
+Om te beoordelen of uw organisatie NL Design tokens nodig heeft of moet aanpassen kunt u het [landelijke overzicht van NL Design tokens](https://github.com/nl-design-system/themes/tree/main/proprietary) raadplegen.
 
 ## Benodigde informatie voor de inrichting
-Voor de inrichting van de OpenWOO-app heeft uw leverancier of u de volgende informatie nodig:
+
+Voor de inrichting van OpenWoo.app heeft uw leverancier of u de volgende informatie nodig:
 
 - Welke afbeelding moet er worden getoond in de jumbotron? (afbeelding boven aan de landingspagina)
-- Welke contact gegevens moeten er in de footer worden getoond? Denk daarbij aan
+- Welke contactgegevens moeten er in de footer worden getoond? Denk daarbij aan
   - Adresgegevens (bezoekadres en postadres)
   - Email
   - Telefoonnummer
   - Website
   - e.v.t socialmedia (Facebook, Instagram etc)
-  - Verplichte context pagina's waarvoor word doorverwezen naar uw eigen site (privacy, over deze pagina, toegankenlijkheid)
+  - Verplichte context pagina's waarvoor word doorverwezen naar uw eigen site (privacy, over deze pagina, toegankelijkheid)
   - Overige website waar u naar wilt verwijzen
-- Op welk (sub) domein moet de pagina worden getoond? b.v. open.`uw organisatie naam`.nl
+- Op welk (sub) domein moet de pagina worden getoond? b.v. open.`uw organisatienaam`.nl
 - Moet er gebruik worden gemaakt van een custom certificaat? bijvoorbeeld PKIo
-- Word er gekoppeld op een of meerder zaaksystemen? zo ja welke
-- Word er gekoppeld op een of meerder raadsinformatie systemen? zo ja welke
-- Word er gekoppeld op CMS van de huidige website? zo ja welke
-- Is er een wens voor het kopelleen op overige systemen? (zo als geo, drop publicaties of powerbrowser)
-- Email addres waar eventueel foutraportages naar kunnen worden verstuurd
+- Wordt er gekoppeld op een of meerdere zaaksystemen? Zo ja, welke
+- Wordt er gekoppeld op een of meerdere raadsinformatiesystemen? Zo ja, welke
+- Wordt er gekoppeld op CMS van de huidige website? Zo ja, welke
+- Is er een wens voor het koppelen op overige systemen? (zoals geo, DROP-publicaties of PowerBrowser)
+- E-mailadres waar eventuele foutrapportages naar toe kunnen worden gestuurd
 
 ## Acties voor uitvragende organisatie
+
 Om het neerzetten van een omgeving soepel te laten verlopen, zijn er verschillende acties die de uitvragende organisatie zelf moet ondernemen:
 
 - [ ] Verzamelen en aanleveren benodigde informatie voor de vormgeving
@@ -47,17 +50,18 @@ Om het neerzetten van een omgeving soepel te laten verlopen, zijn er verschillen
 - [ ] Aanvragen en aanleveren bij leverancier van certificaat (indien custom zoals PKIo)
 - [ ] Verzamelen en aanleveren beoogde zaaksystemen, denk hierbij aan:
   - [ ] Endpoint (waar kan de OpenWoo App bevragen).
-  - [ ] Credentials (hoe kan de OpenWoo App zich authentiseren).
+  - [ ] Credentials (hoe kan de OpenWoo App zich authenticeren).
   - [ ] Protocol (welk protocol moet er worden gebruik e.g. xxllnc search, ZGW, StUF, ZDS etc.).
 - [ ] Verzamelen en aanleveren beoogde raadsinformatie denk hierbij aan:
-   - [ ] Endpoint (waar kan de OpenWoo App bevragen).
-   - [ ] Credentials (hoe kan de OpenWoo App zich authenticeren).
+  - [ ] Endpoint (waar kan de OpenWoo App bevragen).
+  - [ ] Credentials (hoe kan de OpenWoo App zich authenticeren).
 - [ ] Verzamelen en aanleveren gegevens van websitekoppeling indien gewenst.
 - [ ] DPIA opstellen.
 - [ ] Inregelen DNS voor (sub)domein.
 - [ ] Inrichten zaaksysteem (zie configuratie).
 
 ## Acties voor leverancier
+
 Aan de hand van de acties voor de opdrachtgever kan uw leverancier vervolgens aan de slag. Als u geen leverancier heeft moet u deze acties zelf verzetten.
 
 - [ ] Uitbreiden of aanmaken NL Design tokens aan de hand van de informatie voor de vormgeving.
@@ -67,15 +71,16 @@ Aan de hand van de acties voor de opdrachtgever kan uw leverancier vervolgens aa
 - [ ] Aan uitvrager laten weten dat er een acceptatie kan plaatsvinden.
 
 Wat doet de leverancier niet
+
 - Aanleveren WCAG raportage (deze staat [hier](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/WCAG-Raportage.pdf))
 - Aanleveren PEN test (deze staat [hier]())
 
 ## Naar productie (Acceptatie)
+
 Als uw leverancier alles heeft klaar gezet is het tijd voor acceptatie en livegang
 
 - [ ] Doorlopen van de [Acceptatie tests](https://documentatie.opencatalogi.nl/pages/Handleidingen/Testen)
 - [ ] Website laten controleren en reviewen door communicatieafdeling
 - [ ] Indien alles correct, aan leverancier laten weten dat er geaccepteerd is.
 - [ ] Op eigen website verwijzen naar de Open Catalogi (deeplinks)
 - [ ] Vier de livegang met een feestje
-