Merge branch 'rubenvdlinde-patch-docs'

docs/partners/DeVault.md

@@ -0,0 +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.
+
+## Voorgeschiedenis
+
+asd
+
+## 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 '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 harverster
+
+## Bevindingen
+
+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).
+
+Schaalbaarheid: Het generen van sitemap.xml-bestanden aan de hand van grotere datasets (1000+) blijkt intensief te zijn
+
+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 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/partners/Tilburg.md

@@ -0,0 +1,36 @@
+# Tilburg
+
+## Context
+De gemeente Tilburg wil graag ...
+
+We hebben hierbij gekeken naar wat er reeds beschickbaar is en zonder uitbreiding kan worden ingezt, welke componenten er nog uitgebreid zouden meoten worden en welke er uberhaupt zouden moeten worden gebouwd
+
+## Componenten
+De gemeente Tilburg wil Woo publicaties graag goedkeuren en aanpassen voordat ze met het publicatie platform , KOOP en andere afnemers worden gedeeld. Dat vergt de volgende ontwikkelingen:
+
+### Publicatie platformen (laag 5: UI)
+Er zijn keuses te maken qua publicaite platform.
+
+- **Koop (Beschickbaar):**
+- **WOOgle (Beschickbaar):**
+- **Website (keuze / uitbreiden ):**
+- **Thema site (keuze / uitbreiden ):**
+- **Zoek pagina (keuze / uitbreiden ):**
+- **Woo Dashboard:** Op dit moment beschikt de Open Indes nog niet over een beheers omgeving. Deze zal dus in zijn geheel ontwikkeld moeten worden ontwikkeld
+
+### Services (laag 4)
+- **Backend for frontend:** Op dit moment beschikt de Open Indes nog niet over een beheers omgeving. Deze zal dus in zijn geheel ontwikkeld moeten worden ontwikkeld
+
+### Integratie (laag 3)
+- **OpenWoo Service (uitbreiden):**
+- **Federatieve Netwerk (Beschickbaar):**
+- **Integratie platform (Beschickbaar):** De gemeente tilburg heeft zelf reeds een integratie platform beschickbaar
+- **Open Index (Beschickbaar):** Voor het index gedeelte van de Open Woo app geld dat deze prublicaties niet langer automatisch door moet zetten maar pas na een controle en aanvulling door een medewerker
+
+### Bronnen (laag 2)
+- **Bonnen:** Tilburg beschikt reeds over een een typo3 website en xxllnce zaaksysteem bijde reeds met OpenWoo.app gekopeld. Voor het archief systeem deVault zijn COnduction en Devault reeds in gesorek over een koppeling. Dat betekend dat de enige nog onbekende bron binnen Tilburg het raads informatie systeem is.
+
+
+## Architectuur
+
+![OpenWeb Architecture](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/partners/Tilburg.svg)

docs/partners/Tilburg.puml

@@ -0,0 +1,67 @@
+@startuml
+title Algemene Architectuur en keuze mogenlijkheden
+footer: OpenWoo.app
+header: OpenWoo.app
+
+
+' Publicatie platformen (Laag 5 UI)
+frame "Publicatie platformen " {
+    interface "Woo Dashboard" AS OiDashboard #e5352c
+    actor "KOOP"  as KOOP #008b6C
+    actor   "WOOGLE" as WOOGLE #008b6C
+    interface "Website" AS Website #F16E06
+    interface "Thema site" as Themasite #F16E06
+    interface "Zoek pagina" as Searchsite #F16E06
+}
+
+' Services(Laag 4)
+frame "Services" {
+    process "Backend for frontend"  as OiBF #e5352c
+}
+
+' Integratie (Laag 3)
+frame "Integratie" {
+    database "Open Index"  as OI #008b6C
+    component "Federatieve Connectie"  as FCS #008b6C
+    process "OpenWoo Service"  as OWS #F16E06
+    component "Integratie Platform"  as IP #008b6C
+}
+
+' Bronnen (Laag 2)
+frame "Bronnen" {
+    database "Zaaksysteem (XXllNC)" as ZRC #008b6C
+    database "Raadsinformatiesysteem (Notubiz)" as RIS #008b6C
+    database "Bestuursinformatiesysteem (iBabs)" as BIS #008b6C
+    database "Website (Typo3)" as CMS #008b6C
+    database "DMS (Sharepoint)" as SP #008b6C
+    database "Archief (DeVault)" as DEPOT #008b6C
+}
+
+frame "Legenda" {
+    component "Herbruikbaar" #008b6C
+    component "Uitbreiden (doorontwikkeling)" #F16E06
+    component "Te ontwikkelen (nieuw)" #e5352c
+
+
+
+}
+
+OiDashboard -down-> OiBF
+OWS --> IP: Bevraagd via
+IP -down-> ZRC: Woo verzoeken
+IP -down-> SP: Convenanten
+IP -down-> RIS: Raadsstukken
+IP -down-> BIS: Bestuursstukken
+IP -down-> CMS: Organisatie gegevens
+IP -down-> DEPOT: Gearchiveerde gegevens
+OWS ..> OI: Slaat op in
+OiBF --> OI: Beheerd
+
+FCS --> OI : Bevraagd
+
+KOOP -down-> FCS : Indexeerd (XML Sitemap)
+WOOGLE -down-> FCS : Indexeerd (API)
+Website -down-> FCS : Bevraagd (API)
+Themasite -down-> FCS : Bevraagd (API)
+Searchsite -down-> FCS : Bevraagd (API)
+@enduml