Merge pull request #4 from CommonGateway/feature/documentation-2024

Feature/documentation 2024

docs/Architectuur.md

@@ -1 +1,38 @@
-# Uitleg
+# Architectuur van Open Registers
+
+## Inleiding
+
+Open Registers is ontwikkeld met de visie om de dataopslag en -toegang binnen overheidsinstanties te revolutioneren. Door gebruik te maken van moderne technologieën en architecturen biedt het een flexibele, schaalbare en kostenefficiënte oplossing die aansluit op de behoeften van hedendaagse en toekomstige digitale dienstverlening. In dit document wordt de architectuur van Open Registers toegelicht, met een focus op de kerncomponenten en voordelen voor overheidsinstanties.
+
+## Wat voor type product is het initiatief?
+
+Open Registers is geclassificeerd als een toepassing, oftewel een bruikbare oplossing die object storage en API's biedt voor efficiënt datamanagement binnen overheidsinstanties.
+
+## Kerncomponenten
+
+### Symfony Framework
+
+Open Registers is gebouwd op het Symfony framework, een keuze die garant staat voor flexibiliteit, betrouwbaarheid en een breed scala aan functionaliteiten. Deze basis maakt het mogelijk om snel te ontwikkelen en biedt tegelijkertijd een robuuste structuur voor de toepassing.
+
+### Object Storage
+
+In tegenstelling tot traditionele relationele databases, maakt Open Registers gebruik van object storage voor het beheren van data. Dit zorgt voor een ongekende schaalbaarheid en flexibiliteit in het opslaan en ophalen van data, wat essentieel is voor de omgang met grote hoeveelheden en diverse soorten data.
+
+### API-gedreven Toegang
+
+API's spelen een centrale rol in de architectuur van Open Registers, waardoor systemen en applicaties gemakkelijk kunnen integreren en communiceren. Dit faciliteert de ontwikkeling van nieuwe diensten en de uitbreiding van bestaande functionaliteiten.
+
+### Federale Netwerken en Multi-Tenant Ondersteuning
+
+De architectuur is ontworpen om naadloos te integreren binnen federale netwerken, met ondersteuning voor multi-tenancy. Dit betekent dat Open Registers flexibel inzetbaar is binnen verschillende organisatorische contexten, terwijl data gescheiden en beveiligd blijft.
+
+## Voordelen voor Overheidsinstanties
+
+- **Flexibiliteit en Schaalbaarheid:** Past zich gemakkelijk aan veranderende eisen en groeiende datahoeveelheden aan.
+- **Soepele Integratie:** Kan naast bestaande systemen draaien, wat een geleidelijke overgang en minimale verstoring mogelijk maakt.
+- **Verbeterde Dienstverlening:** Snellere en flexibelere toegang tot data verbetert de reactiesnelheid en dienstverlening aan inwoners.
+- **Toekomstbestendig:** Voorbereid op toekomstige ontwikkelingen en uitdagingen in digitale dienstverlening.
+
+## Conclusie
+
+Open Registers vertegenwoordigt een belangrijke stap vooruit in de manier waarop overheidsinstanties data beheren en toegankelijk maken. Met zijn moderne, flexibele en schaalbare architectuur biedt het een krachtige basis voor de ontwikkeling van toekomstige diensten die aansluiten bij de Common Ground visie. Voor gemeenten biedt Open Registers een kans om voorop te lopen in de digitale transformatie en een meer wendbare, efficiënte en inwonergerichte dienstverlening te realiseren.

docs/CONTRIBUTING.md

@@ -0,0 +1,12 @@
+
+## Leveranciers
+
+Wij waarderen de bijdragen van onze leveranciers aan de doorontwikkeling en support van onze projecten. Voor bijdragen, neem contact op via <samenwerken@conduction.nl> of de vermelde contactgegevens. Samenwerking versterkt onze diensten en innoveert.
+
+| Leverancier | Diensten | Contactgegevens |
+|-------------|---------------------|---------|
+|    Conduction         |       Doorontwikkeling, Support     |     <samenwerken@conduction.nl>    |
+|      Yard     |         Doorontwikkeling            |         |
+|       Acato      |     Doorontwikkeling                |         |
+|      SIMgroep       |      Doorontwikkeling               |         |
+|      xxllnc       |        Doorontwikkeling             |         |

docs/GOVERNANCE.md

@@ -0,0 +1,22 @@
+
+## Deelnemende gemeenten
+
+| Organisatie       | Type     | Community | Gebruiker | Projecten                   |
+|-------------------|----------|-----------|-----------|-----------------------------|
+| Noordwijk         | Gemeente | ✓         |     ✓      | OpenWoo.app                 |
+| Tubbergen         | Gemeente | ✓         |     ✓      | OpenWoo.app                 |
+| Buren             | Gemeente | ✓         |      ✓     | Klanten                     |
+| Epe               | Gemeente | ✓         |      ✓     | OpenWoo.app                 |
+| Rotterdam         | Gemeente | ✓         |      ✓     | Open Catalogi               |
+| Noaberkracht      | Samenwerkingsverband| ✓         |      ✓     |
+| Leiden            | Gemeente | ✓         |         ✓  | Open Catalogi               |
+| Gouda             | Gemeente | ✓         |     ✓      | OpenWoo.app, klanten, Zaken |
+| Zutphen           | Gemeente | ✓         |     ✓      | OpenWoo.app                 |
+| Roosendaal        | Gemeente | ✓         |     ✓      | OpenWoo.app                 |
+| Alkmaar           | Gemeente | ✓         |     ✓      | OpenWoo.app                 |
+| Barendrecht       | Gemeente | ✓         |     ✓      | Klanten                     |
+| Albrandswaard     | Gemeente | ✓         |     ✓      | Klanten                     |
+| Ridderkerk        | Gemeente | ✓         |     ✓      | Klanten                     |
+| Hoeksche Waard    | Gemeente | ✓         |     ✓      | Klanten                     |
+| Sud-West Fryslan  | Gemeente | ✓         |     ✓      | Klanten                     |
+| Fryske Marren     | Gemeente | ✓         |     ✓      | Klanten                     |

docs/vragenlijst_vng.md

@@ -2,62 +2,82 @@
 
 ## 1 Wat is de naam van het initiatief dat je wilt aanmelden?
 
-OpenRegisters
+Open Registers
 
 ## 2 Wat voor type product is het initiatief?
 
 * Toepassing (bruikbare oplossing)
 
 ## 3 Indien een toepassing, welke componenten zijn hierin opgenomen?
 
-OpenRegisters maakt gebruik van een innovatief framework gebaseerd op Symfony voor het bieden van object storage en API's. Het integreert federale netwerken en biedt multi-tenant ondersteuning.
+* FSC/NLX
+
+* Objectstore(MonggoDB)
+* Symfony
+* API Platform
+* Database(MySQL/PostgrSQL/MsSQL)
 
 ## 4 Indien het initiatief software betreft, is het parallel te gebruiken naast de bestaande software die het moet vervangen?
 
-Ja, OpenRegisters is ontworpen om naast bestaande systemen te functioneren en ondersteunt een soepele overgang van traditionele databases naar een meer flexibele en schaalbare dataopslag.
+Ja, Open Registers is ontworpen om naast bestaande systemen te functioneren en ondersteunt een soepele overgang van traditionele databases naar een meer flexibele en schaalbare dataopslag. Het kan daarbij zowel koppelen op bestaande databases en die als API ontsluiten als nieuw objectstores aanmaken.
 
 ## 5 Indien een toepassing, pitch je product Waarom zouden anderen moeten mee doen met de ontwikkeling of waarom zouden andere gemeenten jouw product moeten implementeren
 
-OpenRegisters transformeert dataopslag en -toegang voor overheidsinstanties door een snelle en betrouwbare oplossing te bieden die de beperkingen van traditionele databases elimineert. Het verhoogt de efficiëntie en schaalbaarheid van data-integratie en -beheer, essentieel voor het realiseren van de Common Ground visie.
+Open Registers transformeert de manier waarop overheidsinstanties data beheren, met een focus op snelheid, efficiëntie, en schaalbaarheid die essentieel zijn voor de realisatie van Common Ground. Dit framework maakt directe opslag in object stores mogelijk, elimineert de beperkingen van traditionele databases, en integreert naadloos federale netwerken en multi-tenant ondersteuning. Kiezen voor Open Registers betekent investeren in een toekomstbestendige oplossing die uw organisatie flexibeler, sneller en kostenefficiënter maakt.
 
 ## 6 In welk domein past het initiatief?
 
 Overkoepelend/ randvoorwaardelijk voor CG
 
+## 7 Welk type organisaties zijn betrokken?
+
+* Gemeenten
+* Leveranciers
+* VNG
+* Ketenpartners
+
 ## 8 Welke gemeenten zijn aangesloten bij de realisatie van dit initiatief?
 
-Rotterdam
-Gouda
-Noordwijk
-Tubbergen
-Epe
-Dinkelland
-Leiden
-Roermond
-Assen
-Hilversum
-Haarlemermeer
-Enschede
-Eindhoven
-Hardewijk
+Rotterdam (Via OpenCatalogi)
+Gouda (Via OpenCatalogi)
+Noordwijk (Via OpenWoo.app)
+Tubbergen (Via OpenWoo.app)
+Epe (Via OpenWoo.app)
+Dinkelland (Via OpenWoo.app)
+Leiden (Via OpenCatalogi)
+Roermond (Via OpenWoo.app)
+Assen (Via OpenWoo.app)
+Hilversum (Via OpenWoo.app)
+Haarlemermeer (Via OpenWoo.app)
+Enschede (Via OpenWoo.app)
+Eindhoven (Via OpenWoo.app)
+Hardewijk (Via OpenWoo.app)
 
 ## 9 Welke gemeenten maken gebruik van dit initiatief?
 
-Rotterdam
-Buren
-Epe
-Roozendaal
-Gouda
-Noordwijk
-Zutphen
+Noordwijk (Via OpenWoo.app)
+Tubbergen (Via OpenWoo.app)
+Epe(Via OpenWoo.app)
+Rotterdam (Via OpenCatalogi)
+Gouda (Via OpenWoo.app, Open Registers | Klanten, Open Registers | Zaken)
+Zutphen (Via OpenWoo.app)
+Roosendaal (Via OpenWoo.app)
+Alkmaar (Via OpenCatalogi)
+Buren (Via Open Registers | Klanten)
+Barendrecht (Via Open Registers | Klanten)
+Albrandswaard (Via Open Registers | Klanten)
+Ridderkerk (Via Open Registers | Klanten)
+Hoeksche Waard (Via Open Registers | Klanten)
+Sud-West Fryslan (Via Open Registers | Klanten)
+Fryske Marren (Via Open Registers | Klanten)
 
 ## 10 Welke leveranciers zijn betrokken?
 
-Conduction B.V
-Yard
-Acato
-Sim Groep
-Xxllnc
+Conduction B.V (Via OpenWoo.app en  OpenCatalogi)
+Yard (Via OpenWoo.app)
+Acato (Via OpenWoo.app)
+Sim Groep (Via OpenWoo.app en  OpenCatalogi)
+Xxllnc (Via OpenWoo.app en Open Registers | Klanten)
 
 ## 11 Wat is de startdatum van het initiatief
 
@@ -69,23 +89,23 @@ Xxllnc
 
 ## 13 Welke organisatie wordt aangehouden als contact organisatie?
 
-Conduction B.V. 
+Conduction B.V.
 
 ## 14 Wie is de PO (product owner) van dit initiatief? (en dus contactpersoon)
 
 Ruben van der Linde
 
 ## 15 Wat is het emailadres van de PO?
 
-ruben@conduction.nl
+<ruben@conduction.nl>
 
 ## 16 Op welke website kunnen we meer info over het product vinden? (Kan ook link naar groepspagina op commongroundnl zijn)
 
-https://openregisters.app/
+<https://openregisters.app/>
 
 ## 17 Wat is een korte omschrijving van het product?
 
-OpenRegisters biedt een revolutionaire benadering van dataopslag en -toegang voor overheidsinstanties door het gebruik van object stores en API's, wat resulteert in verhoogde snelheid, flexibiliteit en schaalbaarheid in datamanagement.
+Gemakkelijk maken, beheren en hosten van registers op basis van o.a. VNG API-standaarden
 
 ## 18 Hoeverre draagt het initiatief volgens jou bij aan de wendbaarheid van gemeenten?
 
@@ -118,7 +138,7 @@ Hoewel OpenRegisters primair gericht is op het verbeteren van dataopslag en -toe
 
 ## 24 Waar staat informatie over de planning? Voeg indien mogelijk de link toe
 
-Op te vragen bij leverancier
+Deze informatie wordt bijgehouden op de website van OpenRegisters: <https://openregisters.app/>
 
 ## 25 Op welke laag of op welke lagen bevindt dit initiatief zich
 
@@ -127,14 +147,20 @@ laag 2: toegang tot data/ API's
 
 ## 26 Welke API-standaarden zijn toegepast? (zie ook <https://wwwgemmaonlinenl/indexphp/Overzicht_vastgestelde_standaarden>)
 
-(Voer uw antwoord in)
+Haal Centraal
+API-standaarden voor ZGW-werken
+API-standaarden voor klanten en klant interacties
+NL-API strategie
+NL-GOV profiel voor cloud events
 
 ## 27 In welke fase bevindt het initiatief zich?
 
 * Doorontwikkeling en beheer (stabiel, onderdeel gevestigde orde)
 
 ## 28 Waar zijn jullie tegenaan gelopen? In zowel ontwikkeling en waar van toepassing bij de implementatie Noem de een tot drie grootste punten
 
-(Voer uw antwoord in)
+Er is nog een gebrek aan overkoepelende API patronen (zo als extend) waardoor het ook lastig is om een overkoepeld framework neer te zetten dat deze patronen ondersteund, commercieel en politiek hebben we er veel last van dat vanuit de VNG  alleen de oplossingen van Utrecht / Den Haag worden gezien als het gaat om componenten die standaarden leveren waardoor het moeilijk is voor andere overheden en leveranciers om hun open-source oplossing onder de aandacht te brengen. Dit verminderd het aantal deelnemers in het speelveld en is daarmee schadelijk voor innovatie.
 
 ## 29 Zijn er nog vragen naar aanleiding van dit intakeformulier?
+
+Nee