From 7579502a26ae12d72761705f02b0ea28e892b02c Mon Sep 17 00:00:00 2001 From: Ruben van der Linde Date: Thu, 21 Sep 2023 21:37:07 +0200 Subject: [PATCH] Spellchecks --- README.md | 65 +++++++++++++++++++++----------------------- docs/Architectuur.md | 34 ++++++++++++----------- docs/Installatie.md | 62 +++++++++++++++++++++--------------------- docs/Kosten.md | 24 +++++++++------- docs/Tests.md | 51 ++++++++++++++++++---------------- 5 files changed, 121 insertions(+), 115 deletions(-) diff --git a/README.md b/README.md index bb00bba4..f0f98bcd 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,58 @@ -# Over de Open WOO Website +# Over de Open WOO Website -Dit is een zelfstandig bruikbare uitbreiding op [Open WOO](https://github.com/OpenWebconcept/plugin-openwoo) van het [Open Webconcept](https://openwebconcept.nl/). Het maakt hergebruik van [NL Design (React componenten)](https://nldesignsystem.nl/meedoen/introductie) om aan de hand van [Design Tokens](https://nldesignsystem.nl/meedoen/design-tokens/) een gemeentelijk specifieke [WOO-index](https://www.koopoverheid.nl/voor-overheden/rijksoverheid/woo-index) pagina's te genereren die voldoet aan alle [WCAG](https://wcag.nl/kennis/richtlijnen/) en [wettelijke eisen](https://www.rijksoverheid.nl/onderwerpen/wet-open-overheid-woo). +Dit is een zelfstandig bruikbare uitbreiding op [Open WOO](https://github.com/OpenWebconcept/plugin-openwoo) van het [Open Webconcept](https://openwebconcept.nl/). Het maakt hergebruik van [NL Design (React componenten)](https://nldesignsystem.nl/meedoen/introductie) om aan de hand van [Design Tokens](https://nldesignsystem.nl/meedoen/design-tokens/) gemeentelijk specifieke [WOO-index](https://www.koopoverheid.nl/voor-overheden/rijksoverheid/woo-index) pagina's te genereren die voldoen aan alle [WCAG](https://wcag.nl/kennis/richtlijnen/) en [wettelijke eisen](https://www.rijksoverheid.nl/onderwerpen/wet-open-overheid-woo). ![epe.png](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/epe.png "WOO Website van de Gemeente Epe") -## Opzet -Deze pagina kan rechtstreeks vanaf GitHub (serverless) of los op een eigen omgeving gehost worden. Voor de getoonde data wordt vervolgens gebruik gemaakt van de Open WOO API definitie. Dat betekend dat één van de volgende bronnen kan worden gebruikt +## Opzet -- Een ([Open Webconcept](https://openwebconcept.nl/)) Wordpress installatie met de [Open WOO Plugin](https://github.com/OpenWebconcept/plugin-openwoo) -- Een ([Common Gateway](https://commongateway.app/)) Syfmony installatie met de [Open WOO bundle](https://github.com/CommonGateway/WooBundle) -- Een ([Open Online](https://www.dimpact.nl/nieuws/gemeente-vught-live-met-open-online)) Drupal installatie met de Open WOO plugin ([roadmap](/docs/Roadmap.md)). -- Een los JSON bestand dat de data bevat vanuit de repository ([roadmap](/docs/Roadmap.md)). -- Een rechtstreeks vanuit het zaak en/of raadsinformatie systeem ontsloten API +Deze pagina kan rechtstreeks vanaf GitHub (serverless) of los op een eigen omgeving gehost worden. Voor de getoonde data wordt gebruikgemaakt van de Open WOO API-definitie. Dat betekent dat een van de volgende bronnen kan worden gebruikt: -Voor de pagina maakt het niet uit wie de bron is, zolang deze zich maar aan de standaard houdt. -Meer details hierover vind u onder [architectuur](/docs/Architectuur.md). +- Een ([Open Webconcept](https://openwebconcept.nl/)) WordPress installatie met de [Open WOO Plugin](https://github.com/OpenWebconcept/plugin-openwoo) +- Een ([Common Gateway](https://commongateway.app/)) Symfony installatie met de [Open WOO bundle](https://github.com/CommonGateway/WooBundle) +- Een ([Open Online](https://www.dimpact.nl/nieuws/gemeente-vught-live-met-open-online)) Drupal installatie met de Open WOO plugin ([roadmap](/docs/Roadmap.md)) +- Een los JSON-bestand dat de data bevat vanuit de repository ([roadmap](/docs/Roadmap.md)) +- Een rechtstreeks vanuit het zaak- en/of raadsinformatiesysteem ontsloten API +Voor de pagina maakt het niet uit wie de bron is, zolang deze zich maar aan de standaard houdt. +Meer details hierover vindt u onder [architectuur](/docs/Architectuur.md). -![https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/components.svg](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/components.svg "Website Architecture") +![Website Architecture](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/components.svg "Website Architecture") ### WOO 1.0 -Voor de eerste opzet van de WOO Index van BZK is het belangrijk dat organisaties zelf hun WOO-publicaties op een doorzoekbare index publiceren. BZK houdt vervolgens een overzichtspagina bij waarop per organisatie de algemene organisatiegegevens en de organisaties specifieke indexpagina vindbaar zijn. +Voor de eerste opzet van de WOO Index van BZK is het belangrijk dat organisaties zelf hun WOO-publicaties op een doorzoekbare index publiceren. BZK houdt vervolgens een overzichtspagina bij waarop per organisatie de algemene organisatiegegevens en de organisatiespecifieke indexpagina vindbaar zijn. ### WOO 2.0 -BZK heeft de ambitie om aan de hand van een harvester een eigen index op te bouwen op open.overheid.nl. Deze harvesters maakt gebruik van `robot.txt` en `sitemap.xml`-bestanden om de verschillende pagina's en metadata van de organisatie specifieke index te vinden en over te nemen. Dat betekent dat ook binnen de 2.0 variant van WOO een eigen indexpagina noodzakelijk blijft. Sterker nog, de kwaliteit van de ontsluiting wordt in grote mate afhankelijk van de kwaliteit van de index. +BZK heeft de ambitie om aan de hand van een harvester een eigen index op te bouwen op open.overheid.nl. Deze harvester maakt gebruik van `robots.txt` en `sitemap.xml`-bestanden om de verschillende pagina's en metadata van de organisatiespecifieke index te vinden en over te nemen. Dat betekent dat ook binnen de 2.0 variant van WOO een eigen indexpagina noodzakelijk blijft. Sterker nog, de kwaliteit van de ontsluiting wordt in grote mate afhankelijk van de kwaliteit van de index. ### Open versus WOO -De WOO specificeert een aantal categorieën (zie configuratie) die door een organisatie moeten worden ontsloten, dit template ondersteund dat, maar gaat een stap verder door organisaties ook categorieën te laten toevoegen. Hierdoor kan bredere invulling worden gegeven aan het concept "open" en kunnen bijvoorbeeld ook datasets of algoritmes worden ontsloten. - - +De WOO specificeert een aantal categorieën (zie configuratie) die door een organisatie moeten worden ontsloten. Dit template ondersteunt dat, maar gaat een stap verder door organisaties ook categorieën te laten toevoegen. Hierdoor kan bredere invulling worden gegeven aan het concept "open" en kunnen bijvoorbeeld ook datasets of algoritmes worden ontsloten. ## Functionaliteiten -- Serverless: Common WOO maakt gebruik van de RAD-architectuur principes voor het leveren van een Serverless voorkant. -Eigen huisstijl: Via NL Design tokens de gemeente haar eigen huisstijl gebruiken. Als er nog een NL Design tokens voor uw organisatie zijn helpen wij u uiteraard verder. -Geen handwerk: Door directe bron integratie is het niet nodig WOO-verzoeken etc actief te publiceren -- Als de gemeente gebruikmaakt van Open WOO kan er direct op de Open WOO-API worden gekoppeld -- Als de gemeente een zaaksysteem heeft wat ZGW gebruikt kan er via een gateway op het zaaksysteem worden gekoppeld (bijvoorbeeld xllnc, Roxit) -- WOO-verzoeken ook los worden toegevoegd als JSON-bestand. -- Kosteloos: Als de gemeente beschikt over een Bron, NL Design tokens en de interface servers draait zijn er geen kosten aan het gebruik verbonden. +- Serverless: Common WOO maakt gebruik van de RAD-architectuurprincipes voor het leveren van een serverless voorkant. +- Eigen huisstijl: Via NL Design tokens kan de gemeente haar eigen huisstijl gebruiken. Als er nog geen NL Design tokens voor uw organisatie zijn, helpen wij u uiteraard verder. +- Geen handwerk: Door directe bronintegratie is het niet nodig WOO-verzoeken actief te publiceren. +- Als de gemeente gebruikmaakt van Open WOO, kan er direct op de Open WOO-API worden gekoppeld. +- Als de gemeente een zaaksysteem heeft dat ZGW gebruikt, kan er via een gateway op het zaaksysteem worden gekoppeld (bijvoorbeeld xllnc, Roxit). +- WOO-verzoeken kunnen ook los worden toegevoegd als JSON-bestand. +- Kosteloos: Als de gemeente beschikt over een bron, NL Design tokens en de interfaceservers draait, zijn er geen kosten aan het gebruik verbonden. ## Voorbeelden -| Organisatie | WOO Pagina | WOO Bron(en) | -|-------------|------------|-------------------------| +| Organisatie | WOO Pagina | WOO Bron(en) | +|-------------|------------|--------------| | [Noordwijk](https://conductionnl.github.io/woo-website-noordwijk/) | [Pagina](https://conductionnl.github.io/woo-website-noordwijk/) | Zaaksysteem (acceptatie) | -| [Tubbergen](https://conductionnl.github.io/woo-website-tubbergen/)| [Pagina](https://conductionnl.github.io/woo-website-tubbergen/)| Zaaksysteem (acceptatie) | -|[Epe](https://conductionnl.github.io/woo-website-epe/)| [Pagina](https://conductionnl.github.io/woo-website-epe/)| Zaaksysteem (acceptatie) | -|[Dinkelland](https://conductionnl.github.io/woo-website-dinkelland/)| [Pagina](https://conductionnl.github.io/woo-website-dinkelland/)| Zaaksysteem (acceptatie) | -|[Rotterdam (Alleen vormgeving)](https://conductionnl.github.io/woo-website-rotterdam/)| [Pagina](https://conductionnl.github.io/woo-website-rotterdam/)| Demo | -|[Noaberkracht](https://conductionnl.github.io/woo-website-noaberkracht/)| [Pagina](https://conductionnl.github.io/woo-website-noaberkracht/)| Zaaksysteem (acceptatie) | - |[Leiden (Alleen vormgeving)](https://conductionnl.github.io/woo-website-leiden/)| [Pagina](https://conductionnl.github.io/woo-website-leiden/)| Demo | - |[Xxllnc (Demo omgeving)](https://conductionnl.github.io/woo-website-xxllnc/)| [Pagina](https://conductionnl.github.io/woo-website-xxllnc/)| Demo | +| [Tubbergen](https://conductionnl.github.io/woo-website-tubbergen/) | [Pagina](https://conductionnl.github.io/woo-website-tubbergen/) | Zaaksysteem (acceptatie) | +| [Epe](https://conductionnl.github.io/woo-website-epe/) | [Pagina](https://conductionnl.github.io/woo-website-epe/) | Zaaksysteem (acceptatie) | +| [Dinkelland](https://conductionnl.github.io/woo-website-dinkelland/) | [Pagina](https://conductionnl.github.io/woo-website-dinkelland/) | Zaaksysteem (acceptatie) | +| [Rotterdam (Alleen vormgeving)](https://conductionnl.github.io/woo-website-rotterdam/) | [Pagina](https://conductionnl.github.io/woo-website-rotterdam/) | Demo | +| [Noaberkracht](https://conductionnl.github.io/woo-website-noaberkracht/) | [Pagina](https://conductionnl.github.io/woo-website-noaberkracht/) | Zaaksysteem (acceptatie) | +| [Leiden (Alleen vormgeving)](https://conductionnl.github.io/woo-website-leiden/) | [Pagina](https://conductionnl.github.io/woo-website-leiden/) | Demo | +| [Xxllnc (Demo omgeving)](https://conductionnl.github.io/woo-website-xxllnc/) | [Pagina](https://conductionnl.github.io/woo-website-xxllnc/) | Demo | ## Documentatie @@ -63,4 +61,3 @@ Geen handwerk: Door directe bron integratie is het niet nodig WOO-verzoeken etc - [Roadmap](docs/Roadmap.md) - [Configuratie](docs/Configuratie.md) - [Testscenario's](docs/Tests.md) -. diff --git a/docs/Architectuur.md b/docs/Architectuur.md index 8789d8b2..addd1a50 100644 --- a/docs/Architectuur.md +++ b/docs/Architectuur.md @@ -1,37 +1,39 @@ # Architectuur ## WOO Publicatie Object +Het WOO Publicatie Object vormt de kern van zowel de WOO API als de WOO-website. Dit object bevat alle essentiële informatie over een WOO-publicatie, inclusief metadata, publicatiedatum, bijlagen en andere relevante eigenschappen. Het dient als de centrale entiteit waaromheen de functionaliteiten van de API en de website zijn gebouwd. Door deze gecentraliseerde aanpak is het eenvoudiger om WOO-publicaties efficiënt te beheren, op te halen en weer te geven, en draagt het bij aan een coherente en gestroomlijnde gebruikerservaring. -[NL API Strategie over property namen](https://docs.geostandaarden.nl/api/cv-hr-API-Strategie-20190213/#veldnamen-in-snake_case-camelcase-uppercamelcase-of-kebab-case) - - +Toegepaste norm: [NL API Strategie over property namen](https://docs.geostandaarden.nl/api/cv-hr-API-Strategie-20190213/#veldnamen-in-snake_case-camelcase-uppercamelcase-of-kebab-case) ## Varianten ### Open Webconcept variant -Als de voorkant direct wordt gedraaid op de Open Webconcept plugin kunnen WOO-verzoeken en convenanten gemakkelijk worden beheerd vanuit de reeds bestaande webomgeving en CMS.  In dit geval zijn er aan de kant van de organisatie geen verdere installatie of beheerstichtingen nodig (mits de organisatie beschickt over een OpenWebconcept installatie met de Open Woo en Open Convenanten plugins). In combinatie met het serverless kunnen draaien van de voorkant betekent dit een oplossing zonder server of hosting kosten waarbij simpelweg hergebruik gemaakt kan worden van bestaande Common Ground componenten +Met deze variant kunnen WOO-verzoeken en convenanten eenvoudig worden beheerd vanuit de bestaande webomgeving en CMS door middel van de Open Webconcept plugin. Dit vereist geen extra installatie of beheerinspanningen van de organisatie, op voorwaarde dat er al een OpenWebconcept-installatie met de benodigde plugins beschikbaar is. Dit biedt een serverloze en kostenefficiënte oplossing door het hergebruik van bestaande Common Ground-componenten. -Nadeel van deze oplossingsrichting is dat WOO-verzoeken en convenanten handmatig moeten worden geüpload in de CMS-omgeving en dat de zoekbalk niet wordt ondersteund. +**Nadelen:** +- WOO-verzoeken en convenanten moeten handmatig worden geüpload in de CMS-omgeving. +- De zoekbalk wordt niet ondersteund. -![https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/openweb.svg](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/openweb.svg "OpenWeb Architecture") +![OpenWeb Architecture](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/openweb.svg) ### Common Gateway variant -Het is ook mogelijk om de voorkant te koppelen aan een Common Gateway-installatie met daarop de Open WOO-plugin. Het voordeel hiervan is dat er kan worden doorgekoppeld op het zaaksysteem waardoor WOO-verzoeken en convenanten rechtstreeks kunnen worden gepubliceerd. Dit scheelt handwerk en voorkomt fouten. Tevens ondersteunt deze richting de zoekbalk. Het is ook mogelijk om dit te combineren met het binnentrekken van gegevens uit andere bronnen zoals een raadsinformatiesysteem op Open Webconcept CMS. +Deze variant maakt het mogelijk om de front-end te koppelen aan een Common Gateway-installatie met de Open WOO-plugin. Dit biedt de mogelijkheid om direct te koppelen aan het zaaksysteem, waardoor WOO-verzoeken en convenanten automatisch kunnen worden gepubliceerd. Dit bespaart handmatig werk en vermindert de kans op fouten. De zoekbalk wordt in deze variant wel ondersteund. Het is tevens mogelijk om gegevens uit andere bronnen te integreren, zoals een raadsinformatiesysteem of een Open Webconcept CMS. -Nadeel van deze oplossingsrichting is dat de gemeente de Common Gateway (open source framework) of zelf zal moeten installeren of als SAAS afnemen. +**Nadelen:** +- De organisatie moet de Common Gateway zelf installeren of als SaaS afnemen. -![https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/commongateway.svg](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/commongateway.svg "Commongateway Architecture") +![Commongateway Architecture](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/commongateway.svg) ### Ophalen informatie -In principe "scraped" de Open WOO plugin elke nacht alle relevante zaken, hierbij zijn de stappen +De Open WOO-plugin "scraped" elke nacht alle relevante zaken. De stappen zijn als volgt: -1. Ophalen alle zaaktypen -2. Per zaaktype controleren op beschikbare eigenschappen (zie inrichting zaaksysteem) -3. Per zaaktype dat aan de voorwaarden voldoet de zaken ophalen -4. Per zaak controleren of er een publicatiedatum is, indien ja de zaak opnemen in de index -5. Zaken die niet in bovenstaande loop zijn gevonden, maar momenteel wel in de index zijn opgenomen verwijderen +1. Ophalen van alle zaaktypen. +2. Per zaaktype worden de beschikbare eigenschappen gecontroleerd (zie inrichting zaaksysteem). +3. Voor elk zaaktype dat aan de voorwaarden voldoet, worden de zaken opgehaald. +4. Per zaak wordt gecontroleerd of er een publicatiedatum is; zo ja, wordt de zaak opgenomen in de index. +5. Zaken die niet zijn gevonden in bovenstaande loop maar wel in de index staan, worden verwijderd. -In principe is bovenstaande genoeg om te zorgen dat het zaaksysteem leidend is en zaken zowel gepubliceerd als gedepubliceerd kunnen worden. +Dit proces zorgt ervoor dat het zaaksysteem leidend is en dat zaken zowel kunnen worden gepubliceerd als gedepubliceerd. diff --git a/docs/Installatie.md b/docs/Installatie.md index 88503938..643330f5 100644 --- a/docs/Installatie.md +++ b/docs/Installatie.md @@ -1,47 +1,47 @@ # Installatie -Deze installatie handleiding is bedoeld voor overheden en levernciers die zelfstandig aan de slag willen met Open WOO Website, als je Open WOO website als SAAS wilt afnemen kijk dan onder [kosten](/kosten). +Deze installatiehandleiding is bedoeld voor overheden en leveranciers die zelfstandig aan de slag willen met Open WOO Website. Als je Open WOO Website als SaaS wilt afnemen, kijk dan onder [kosten](/kosten). -Het Open WOO Website template is gebaseerd op het Conduction [Productpage template](https://github.com/ConductionNL/product-website-template) voor commonground. Onderstaande tref je ene verkorte installatie handleiding die vooral focust op de onderliggende bronnen. Voor meer en uitgebreidere details kunt u de documentatie van de Productpage website template gebruiken. +Het Open WOO Website-template is gebaseerd op het Conduction [Productpage-template](https://github.com/ConductionNL/product-website-template) voor CommonGround. Hieronder tref je een verkorte installatiehandleiding aan die vooral focust op de onderliggende bronnen. Voor meer en uitgebreidere details kun je de documentatie van het Productpage-website-template gebruiken. ## Randvoorwaarden -Om dit template te gebruiken moet je beschikken over: +Om dit template te gebruiken, moet je beschikken over: -- NL Design Token voor je organisatie ([lees hier hoe je die kan verkrijgen](https://conductionnl.github.io/product-website-template/pages/Features/NL_Design) -- Een GitHub organisatie en beheerders rechten daarop OF (Zie [Serverless Installatie](#serverless-installatie)) -- Een APACHE/NGINX server(Zie [Server Installatie](#server-installatie)) -- Een Open Webconcept CMS (WordPress) met de [Open WOO](https://github.com/OpenWebconcept/plugin-openwoo)) en [Open Convenanten](https://github.com/OpenWebconcept/plugin-openconvenanten) plugins OF -- Een Common Gateway installatie (On premise of SAAS) met de [WOO Bundle](https://github.com/ConductionNL/WooBundle/tree/main) +- NL Design Token voor je organisatie ([lees hier hoe je die kunt verkrijgen](https://conductionnl.github.io/product-website-template/pages/Features/NL_Design)) +- Een GitHub-organisatie en beheerdersrechten daarop OF (zie [Serverless Installatie](#serverless-installatie)) +- Een APACHE/NGINX-server (zie [Server Installatie](#server-installatie)) +- Een Open Webconcept CMS (WordPress) met de [Open WOO](https://github.com/OpenWebconcept/plugin-openwoo) en [Open Convenanten](https://github.com/OpenWebconcept/plugin-openconvenanten) plugins OF +- Een Common Gateway-installatie (on-premise of SaaS) met de [WOO Bundle](https://github.com/ConductionNL/WooBundle/tree/main) ## Frontend ### Serverless Installatie -De Open WOO Website is in eerste instantie opgezet om serverless gebruikt te worden via GitHub. Dat scheelt niet alleen in de kosten, maar levert ook voordeel op in de beschikbaarheid en belasting. Simpel gezegd de GitHub CDN is gebouwd om flink wat meer aan te kunnen dan de gemiddelde gemeente. +De Open WOO Website is in eerste instantie opgezet om serverless gebruikt te worden via GitHub. Dat scheelt niet alleen in de kosten, maar levert ook voordeel op in de beschikbaarheid en belasting. Simpel gezegd, de GitHub CDN is gebouwd om flink wat meer aan te kunnen dan de gemiddelde gemeente. > **Stappen** ->1. Rechts boven deze repro staat een knop [“gebruiken als template”](https://github.com/new?template_name=woo-website-template&template_owner=ConductionNL) druk daarop (of [klik hier](https://github.com/new?template_name=woo-website-template&template_owner=ConductionNL)) en maak een nieuwe repository aan op uw GitHub-organisatie. ->2. Ga in de repository naar de folder .github/workflows/ ->3. Verwijder de workflwo ``product-page-deploy`` als deze er nog staad ->4. Open de workflow ``woo-page-deploy`` en pas de branche aan van `never` naar main ->3. Pas de verdere configuratie in ``woo-page-deploy`` aan zo als hieronder vermeld onder configuratie en sla deze op ->4. Ga naar acties en wacht tot de actie ``Deploy the WOO Page to GitHub Pages`` succesvol is afgerond ->4. Ga naar settings->pages, selecteer onder source `deploy form branche` en geef als branche op `gh-pages` ->5. Boven aan de pagina verschijnt nu de url waarop u uw Open WOO Website kan terugvinden ->6. Als u de Open WOO Website wilt hosten onder een subdomein van uw organisatie en voorzien van een PKI certificaat kunt u daarvoor de normale github pages handleidingen volgen of een SLA afsluiten voor ondersteuning (zie [kosten]() - +> 1. Rechtsboven deze repo staat een knop ["gebruiken als template"](https://github.com/new?template_name=woo-website-template&template_owner=ConductionNL), druk daarop (of [klik hier](https://github.com/new?template_name=woo-website-template&template_owner=ConductionNL)) en maak een nieuwe repository aan op je GitHub-organisatie. +> 2. Ga in de repository naar de folder `.github/workflows/` +> 3. Verwijder de workflow `product-page-deploy` als deze er nog staat +> 4. Open de workflow `woo-page-deploy` en pas de branche aan van `never` naar `main` +> 5. Pas de verdere configuratie in `woo-page-deploy` aan zoals hieronder vermeld onder configuratie en sla deze op +> 6. Ga naar acties en wacht tot de actie "Deploy the WOO Page to GitHub Pages" succesvol is afgerond +> 7. Ga naar settings->pages, selecteer onder source `deploy from branch` en geef als branche op `gh-pages` +> 8. Bovenaan de pagina verschijnt nu de URL waarop je je Open WOO Website kunt terugvinden +> 9. Als je de Open WOO Website wilt hosten onder een subdomein van je organisatie en voorzien van een PKI-certificaat, kun je daarvoor de normale GitHub Pages-handleidingen volgen of een SLA afsluiten voor ondersteuning (zie [kosten]()) ### Server Installatie -Als je de Open Woo Website liever vanaf een eigen server draaid kan dat uiteraard ook, in dat geval is er wel sprake van een iets wat meer ingewikkelde installatie waarvoor beter de handleiding van het onderliggende framework kan worden gevolgd. + +Als je de Open WOO Website liever vanaf een eigen server draait, kan dat uiteraard ook. In dat geval is er wel sprake van een ietwat ingewikkelder installatie waarvoor je beter de handleiding van het onderliggende framework kunt volgen. > **Stappen** -> 1. Volg de stappen hiervoor op de [Productpage template](https://github.com/ConductionNL/product-website-template) -> 2. Pas het de configuratie aan zoals hieronder onder vermeld bij configuratie +> 1. Volg de stappen hiervoor op de [Productpage-template](https://github.com/ConductionNL/product-website-template) +> 2. Pas de configuratie aan zoals hieronder vermeld bij configuratie ### Configuratie -Configuratie vindt plaats via environment (env) waardes. In het geval van een serverless configuratie moeten de env waardes worden aangepast in de [page deploy workflow](/.github/workflows/woo-page-deploy.yml). In het geval van een server installatie in het .env bestand in de Gatsby root map. We ondersteunen de volgende configuratieopties +Configuratie vindt plaats via environment (env) waardes. In het geval van een serverless configuratie moeten de env-waardes worden aangepast in de [page deploy workflow](/.github/workflows/woo-page-deploy.yml). In het geval van een serverinstallatie in het `.env`-bestand in de Gatsby-rootmap. We ondersteunen de volgende configuratie-opties. | Key | Verplicht | Usage | Allowed Value | Default / Example | |---------------------------|-----------------------|---------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|------------------------------------------------------------------------------------------------| @@ -51,24 +51,24 @@ Configuratie vindt plaats via environment (env) waardes. In het geval van een se | NL_DESIGN_THEME_CLASSNAME | Ja | De naam van het thema van de organisatie | string, max 255 characters | "conduction-theme" | | FAVICON_URL | Ja | De locatie van de favicon van de organisatie | string , max 255 characters | "" | | HEADER_LOGO_URL | Ja | De locatie van het primaire logo van de organisatie | string, moet een base encoded afbeelding zijn OF url | "" | -| ORGANISATION_NAME | Ja | De naam van de Organisatie | string, max 255 characters | "Conduction" | -| JUMBOTRON_IMAGE_URL | Nee | De locatie van de gebruikte header, bij leeg wordt er geen header getoont | string , max 255 characters | "" | +| ORGANISATION_NAME | Ja | De naam van de organisatie | string, max 255 characters | "Conduction" | +| JUMBOTRON_IMAGE_URL | Nee | De locatie van de gebruikte header, bij leeg wordt er geen header getoond | string , max 255 characters | "" | | FOOTER_LOGO_URL | Ja | De locatie van het primaire logo van de organisatie | string, moet een base encoded afbeelding zijn OF url | ... | | FOOTER_LOGO_HREF | Ja | De homepage van de organisatie | string , max 255 characters | "" | -| OIDN_NUMBER | Nee | Het OIDN nummer van de organisatie, bij leeg worden WOO publicaties mogenlijk niet beperkt tot de eigen organisatie | integer, max 16 characters | 1234567890 | +| OIDN_NUMBER | Nee | Het OIDN-nummer van de organisatie, bij leeg worden WOO-publicaties mogelijk niet beperkt tot de eigen organisatie | integer, max 16 characters | 1234567890 | ## Backend -Voor de backend zijn twee opties beschikbaar, in beide gevallen moet de resulterende URL worden opgenomen onder `API_BASE_URL` in de frontend configuratie. +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 +### Open Webconcept met Open WOO en Open Convenanten Plugin -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) +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 Volg de installatiehandleiding op [WOO Bundle](https://github.com/ConductionNL/WooBundle/tree/main). -## Externe systemen -Voor het koppelen van externe systemen geld dat zij op de juiste manier moeten zijn geconfigureerd, kijk daarvoor onder [configuratie](/Configuratie). +## Externe Systemen +Voor het koppelen van externe systemen geldt dat zij op de juiste manier moeten zijn geconfigureerd. Kijk daarvoor onder [configuratie](/Configuratie). diff --git a/docs/Kosten.md b/docs/Kosten.md index e7b60ec7..2d0eda6a 100644 --- a/docs/Kosten.md +++ b/docs/Kosten.md @@ -1,16 +1,18 @@ # Kosten -Het is mogelijk om de WOO Website af te nemen als SAAS of ondersteuning te krijgen op uw eigen installatie in de vorm van een SLA of implementatie. Conduction en Xxlnce bieden momenteel de volgende ondersteuningsmogelijkheden aan. +Het is mogelijk om de WOO Website af te nemen als SAAS of ondersteuning te krijgen op uw eigen installatie in de vorm van een SLA of implementatie. Conduction en xxlnce bieden momenteel de volgende ondersteuningsmogelijkheden aan. Bent u geïnteresseerd of wilt u meer informatie? Neem dan contact op met een van de leveranciers. ## Leveranciers -| Leverancier | Contactpersoon | -|-------------|------------------------------------------| -| Conduction | Ruben van der Linde (ruben@conduction.nl)| -| Xxlnce | Remco Damhuis (remco.damhuis@xxllnc.nl) | +| Leverancier | Contactpersoon | +|-------------|----------------------------------------------| +| Conduction | Ruben van der Linde (info@conduction.nl) | +| xxlnce | Remco Damhuis (sales.zaakgericht@@xxllnc.nl) | ## Frontend +Kijk op [https://conductionnl.github.io/woo-website-xxllnc/](de demo pagina) voor een voorbeeld van de omgeving of op [de product home page](https://openwoo.app/) voor een overzicht van de omgevingen die in ontwikkeling zijn. + | Dienst | Kosten | |------------------------------------------------|------------------------| | Implementatie | €1750,- (eenmalig) | @@ -18,7 +20,7 @@ Bent u geïnteresseerd of wilt u meer informatie? Neem dan contact op met een va | SLA of SAAS frontend | €250,- (maandelijks) | **Waarop zijn de maandelijkse kosten gebaseerd?** -Naar aanleiding van eerdere ervaringen verwachten we dat de frontend ongeveer maandelijks moet worden bijgewerkt in verband met veiligheidsupdates, nieuwe functionaliteit of aanpassingen in NL Design. Met name de ontwikkelingen in de WOO zullen ervoor zorgen dat de pagina de komende jaren continu in beweging is. +Lost van hosting verwachten we na aanleiding van eerdere ervaringen dat de frontend ongeveer maandelijks moet worden bijgewerkt in verband met veiligheidsupdates, nieuwe functionaliteit of aanpassingen in NL Design. Met name de ontwikkelingen in de WOO zullen ervoor zorgen dat de pagina de komende jaren continu in beweging is. > **Opmerking** > NL Design tokens zijn een randvoorwaarde (vereiste) voor het gebruik van de frontend. Als uw organisatie hier reeds over beschikt, hoeven deze uiteraard niet opnieuw te worden gemaakt. Wel is het mogelijk dat uw huidige token set moet worden uitgebreid; in dat geval volgt een maatwerkofferte. Let op! De prijsstelling is gebaseerd op een aangeleverde en volledige huisstijlgids. Indien deze niet beschikbaar is, moeten de tokens worden gereverse-engineerd vanaf uw website. Daar zijn extra kosten aan verbonden. @@ -33,11 +35,13 @@ Het is mogenlijk om de Open WOO Website rechtstreeks aan uw zaaksysteem te koppe > **Opmerking** -> Via een Stuf <-> ZGW koppelvlak is het in theorie ook mogelijk een zaaksysteem te koppelen aan de hand van Stuf, dit is in de praktijk echter nog niet beproeft. +> Via een Stuf <-> ZGW koppelvlak is het in theorie ook mogelijk een zaaksysteem te koppelen aan de hand van Stuf, dit is in de praktijk echter nog niet beproeft. Andere koppelvlakken en maatwerk zijn uiteraard bespreekbaar, neem daarvoor contact op met een leverancier. -## Inrichting zaaksysteem.nl -Indien uw organisatie gebruik maakt van zaaksysteem.nl is het mogenlijk om ondersteuning/consultancy te krijgen bij het inrichten van uw zaaktypen en Search endpoint. +## IConfiguratie en inrichting xxllnc Zaken +Klanten van xxllnc Zaken (zaaksysteem.nl) kunnen voor het inrichten van het modelzaaktype tbv WOO-publicatie en de configuratie van de integratie gebruik maken van een Consultant. | Dienst | Kosten | |------------------------------|------------------------| -| Implementatie searchendpoint | €3000,- (eenmalig) | +| Installatie en configuratie WOO-index integratie | €3000,- (eenmalig) | + +Mocht u nog niet beschikken over xxllnc Zaken (zaaksysteem.nl) maar wel behoefte hebben aan een manier om de documenten conform een ingericht proces te gaan publiceren en achteraf correct te kunnen archiveren neem dan contact met ons op via: sales.zaakgericht@xxllnc.nl. Wij gaan graag in gesprek over de mogelijkheden hiervoor! diff --git a/docs/Tests.md b/docs/Tests.md index 41282c2f..afecd05e 100644 --- a/docs/Tests.md +++ b/docs/Tests.md @@ -1,6 +1,8 @@ # Testscenario's -We kunnen de testscript opsplitsen in de volgende categorieën: +Om de Open WOO Website zelfstandig te kunnen installeren of doorontwikkelen, is het belangrijk om ook over herbruikbare testscenario's te beschikken. + +We kunnen de testscripts opsplitsen in de volgende categorieën: 1. Opzet en voorwaarden: Hier beschrijven we de omgevingseisen en initialisatieprocedures. 2. Testcases: De daadwerkelijke testscenario's. @@ -8,21 +10,21 @@ We kunnen de testscript opsplitsen in de volgende categorieën: ## 1. Opzet en voorwaarden -**Omgevingseisen**: Zorg ervoor dat je een lokale/testversie van de (Open) WOO Website Template hebt draaien. +**Omgevingseisen**: Zorg ervoor dat je een lokale/testversie van de Open WOO Website Template hebt draaien. **Initialisatie**: Configureer de `API_BASE_URL` in de WOO Website Template om te wijzen naar het test-zaaksysteem. - Zorg ervoor dat het zaaksysteem is geconfigureerd zoals beschreven in de documentatie. +Zorg ervoor dat het zaaksysteem is geconfigureerd zoals beschreven in de documentatie. ## 2. Testcases ### Testcase 1: Een nieuwe WOO-publicatie toevoegen in het zaaksysteem -**Doel**: Verifiëren dat een nieuw WOO-publicatie correct wordt weergegeven op de WOO-website. +**Doel**: Verifiëren dat een nieuwe WOO-publicatie correct wordt weergegeven op de WOO-website. **Stappen**: -1. Voeg een nieuw WOO-publicatie toe in het zaaksysteem met een publicatiedatum die nu is of in het verleden. +1. Voeg een nieuwe WOO-publicatie toe in het zaaksysteem met een publicatiedatum die nu is of in het verleden. 2. Laat het zaaksysteem synchroniseren met de WOO-website. 3. Ga naar de WOO-website en controleer of het nieuwe verzoek correct wordt weergegeven. @@ -32,11 +34,11 @@ We kunnen de testscript opsplitsen in de volgende categorieën: ### Testcase 2: Een nieuwe WOO-publicatie klaarzetten in het zaaksysteem -**Doel**: Verifiëren dat een nieuw WOO-publicatie correct pas wordt weergegeven op de WOO-website na de publicatiedatum. +**Doel**: Verifiëren dat een nieuwe WOO-publicatie correct pas wordt weergegeven op de WOO-website na de publicatiedatum. **Stappen**: -1. Voeg een nieuw WOO-publicatie toe in het zaaksysteem met een publicatiedatum die in de toekomst is. +1. Voeg een nieuwe WOO-publicatie toe in het zaaksysteem met een publicatiedatum die in de toekomst is. 2. Laat het zaaksysteem synchroniseren met de WOO-website. 3. Ga naar de WOO-website en controleer of het nieuwe verzoek niet wordt weergegeven. @@ -58,9 +60,9 @@ We kunnen de testscript opsplitsen in de volgende categorieën: - Het nieuwe WOO-publicatie moet niet zichtbaar zijn op de WOO-website. -### Testcase 4: Synchronyseren van categoriën +### Testcase 4: Synchroniseren van categorieën -**Doel**: Verifiëren dat WOO-publicatie's onder de juiste categorie worden overgenomen uit het zaaksysteem. +**Doel**: Verifiëren dat WOO-publicaties onder de juiste categorie worden overgenomen uit het zaaksysteem. **Stappen**: @@ -70,7 +72,7 @@ We kunnen de testscript opsplitsen in de volgende categorieën: **Verwachte resultaten**: -- Het nieuwe WOO-publicatie moet niet zichtbaar zijn op de WOO-website. +- De nieuwe WOO-publicaties moeten zichtbaar zijn op de WOO-website en moeten alle relevante informatie correct weergeven. ### Testcase 5: Een WOO-publicatie verwijderen uit het zaaksysteem @@ -88,30 +90,30 @@ We kunnen de testscript opsplitsen in de volgende categorieën: ### Testcase 6: Een WOO-publicatie depubliceren uit het zaaksysteem -**Doel**: Verifiëren dat een verwijderd WOO-publicatie niet meer wordt weergegeven op de WOO-website. +**Doel**: Verifiëren dat een gedepubliceerd WOO-publicatie niet meer wordt weergegeven op de WOO-website. **Stappen**: 1. Voeg een nieuw WOO-publicatie toe in het zaaksysteem met een publicatiedatum die nu is of in het verleden. 2. Laat het zaaksysteem synchroniseren met de WOO-website. 3. Ga naar de WOO-website en controleer of het nieuwe verzoek correct wordt weergegeven. -4. Verwijder nu de publicatie datum op het WOO-publicatie in het zaaksysteen. +4. Verwijder nu de publicatiedatum op het WOO-publicatie in het zaaksysteem. 5. Laat het zaaksysteem opnieuw synchroniseren met de WOO-website. 6. Ga naar de WOO-website en controleer of het gedepubliceerde verzoek niet meer zichtbaar is. **Verwachte resultaten**: -- Het nieuwe WOO-publicatie moet zichtbaar na aanmaken zijn op de WOO-website en moet alle relevante informatie correct weergeven. -- Het nieuwe WOO-publicatie moet na het aanpassen van de publicatiedatum niet meer zichtbaar zijn op de website +- Het nieuwe WOO-publicatie moet na aanmaak zichtbaar zijn op de WOO-website en moet alle relevante informatie correct weergeven. +- Het gedepubliceerde WOO-publicatie moet niet meer zichtbaar zijn op de website na het verwijderen van de publicatiedatum. -### Testcase 7: Volledigheid van een woo publicatie (bijlagen en omschrijving) +### Testcase 7: Volledigheid van een WOO-publicatie (bijlagen en omschrijving) **Doel**: Verifiëren dat een WOO-publicatie volledig wordt weergegeven op de WOO-website. **Stappen**: -1. Voeg een nieuwe WOO-publicatie toe in het zaaksysteem met een publicatiedatum die nu is of in het verleden en als categorie `Woo-verzoeken en -besluiten`. -2. Voeg meerdere bijlagen toe, waarvan +1. Voeg een nieuwe WOO-publicatie toe in het zaaksysteem met een publicatiedatum die nu is of in het verleden en met de categorie `Woo-verzoeken en -besluiten`. +2. Voeg meerdere bijlagen toe, waarvan: - Minimaal één gelabeld als besluit (en publiek) - Minimaal één gelabeld als informatieverzoek (en publiek) - Minimaal één gelabeld als inventarisatielijst (en publiek) @@ -119,7 +121,7 @@ We kunnen de testscript opsplitsen in de volgende categorieën: - Minimaal één niet publiek 3. Geef een onderwerp op 4. Geef een omschrijving op -5. Geef meerdere thema's op, gescheiden door een , +5. Geef meerdere thema's op, gescheiden door een komma 6. Laat het zaaksysteem synchroniseren met de WOO-website. 7. Ga naar de WOO-website en controleer of het nieuwe verzoek correct wordt weergegeven. @@ -127,13 +129,14 @@ We kunnen de testscript opsplitsen in de volgende categorieën: - Het nieuwe WOO-publicatie moet zichtbaar zijn op de WOO-website en moet alle relevante informatie correct weergeven. - De als besluit gemarkeerde bijlage moet worden weergegeven onder besluiten -- De als besluit gemarkeerde informatieverzoek moet worden weergegeven onder informatieverzoek -- De als besluit gemarkeerde inventarisatielijst moet worden weergegeven onder inventarisatielijst +- De als informatieverzoek gemarkeerde bijlage moet worden weergegeven onder informatieverzoek +- De als inventarisatielijst gemarkeerde bijlage moet worden weergegeven onder inventarisatielijst - De overige bijlagen moeten worden weergegeven onder bijlagen -- Het zaaknummer moet zichtbaar zijn onder Kenmerk -- De omschrijving moet zichtbaar zijn onder Samenvatting -- De niet publieke bijlagen moeten niet worden weergegeven +- Het zaaknummer moet zichtbaar zijn onder kenmerk +- De omschrijving moet zichtbaar zijn onder samenvatting +- De niet-publieke bijlagen moeten niet worden weergegeven ## 3. Schoonmaak - Verwijder alle testdata uit het zaaksysteem en de WOO-website. +Verwijder alle testdata uit het zaaksysteem en de WOO-website. +