Skip to content

Commit

Permalink
spellecheck
Browse files Browse the repository at this point in the history
  • Loading branch information
@MWest2020
MWest2020 committed Sep 22, 2023
1 parent 7579502 commit 97bf677
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 32 deletions.
15 changes: 9 additions & 6 deletions docs/Architectuur.md
View file
Original file line number Diff line number Diff line change
@@ -1,34 +1,37 @@
# 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.
## 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.

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

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.
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.

**Nadelen:**
- WOO-verzoeken en convenanten moeten handmatig worden geüpload in de CMS-omgeving.

- Woo-verzoeken en convenanten moeten handmatig worden geüpload in de CMS-omgeving.
- De zoekbalk wordt niet ondersteund.

![OpenWeb Architecture](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/openweb.svg)

### Common Gateway variant

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.
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.

**Nadelen:**

- De organisatie moet de Common Gateway zelf installeren of als SaaS afnemen.

![Commongateway Architecture](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/commongateway.svg)

### Ophalen informatie

De Open WOO-plugin "scraped" elke nacht alle relevante zaken. De stappen zijn als volgt:
De Open Woo-plugin "scraped" elke nacht alle relevante zaken. De stappen zijn als volgt:

1. Ophalen van alle zaaktypen.
2. Per zaaktype worden de beschikbare eigenschappen gecontroleerd (zie inrichting zaaksysteem).
Expand Down
22 changes: 12 additions & 10 deletions docs/Installatie.md
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Installatie

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).
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. 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.
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

Expand All @@ -11,8 +11,8 @@ Om dit template te gebruiken, moet je beschikken over:
- 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)
- 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

Expand All @@ -21,6 +21,7 @@ Om dit template te gebruiken, moet je beschikken over:
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. 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
Expand All @@ -33,9 +34,10 @@ De Open WOO Website is in eerste instantie opgezet om serverless gebruikt te wor
### Server Installatie

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.
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 de configuratie aan zoals hieronder vermeld bij configuratie
Expand All @@ -47,27 +49,27 @@ Configuratie vindt plaats via environment (env) waardes. In het geval van een se
|---------------------------|-----------------------|---------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|------------------------------------------------------------------------------------------------|
| GITHUB_PAGES_BRANCH | Alleen bij serverless | De branche waarop de pagina wordt gebouwd | string, max 255 characters | gh-pages |
| GITHUB_REPOSITORY_NAME | Alleen bij serverless | | string, max 255 characters | `${{ github.event.repository.name }}` |
| API_BASE_URL | Ja | De locatie van de Open WOO API | string <URL>, string, max 255 characters | "<https://api.gateway.commonground.nu/api>" |
| API_BASE_URL | Ja | De locatie van de Open Woo API | string <URL>, string, max 255 characters | "<https://api.gateway.commonground.nu/api>" |
| 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 <URL>, max 255 characters | "<https://conduction.nl/wp-content/uploads/2021/07/cropped-favicon-32x32.png>" |
| HEADER_LOGO_URL | Ja | De locatie van het primaire logo van de organisatie | string, moet een base encoded afbeelding zijn OF url | "<https://conduction.nl/wp-content/uploads/2021/07/cropped-conductionlogo-1.png>" |
| 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 <URL>, max 255 characters | "<https://www.conduction.nl/wp-content/uploads/2021/07/cropped-Conduction_HOME_0000_afb1-1.png>" |
| 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 <URL>, max 255 characters | "<https://conduction.nl/>" |
| 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 |
| 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.

### 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).

### Common Gateway met Open WOO Plugin
### Common Gateway met Open Woo Plugin

Volg de installatiehandleiding op [WOO Bundle](https://github.com/ConductionNL/WooBundle/tree/main).
Volg de installatiehandleiding op [Woo Bundle](https://github.com/ConductionNL/WooBundle/tree/main).

## Externe Systemen

Expand Down
35 changes: 19 additions & 16 deletions docs/Kosten.md
View file
Original file line number Diff line number Diff line change
@@ -1,47 +1,50 @@
# 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 ([email protected]) |
| Conduction | Ruben van der Linde (<[email protected]>) |
| 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.

Kijk op [https://conductionnl.github.io/woo-website-xxllnc/](de demo pagina) voor een voorbeeld van de omgeving of op [de product homepage](https://openwoo.app/) voor een overzicht van de omgevingen die in ontwikkeling zijn.

| Dienst | Kosten |
|------------------------------------------------|------------------------|
| Implementatie | €1750,- (eenmalig) |
| Design Tokens (indien nog niet beschikbaar) | €2000,- (eenmalig) |
| SLA of SAAS frontend | €250,- (maandelijks) |
| Implementatie | € 1750,- (eenmalig) |
| Design Tokens (indien nog niet beschikbaar) | € 2000,- (eenmalig) |
| SLA of SAAS-frontend | € 250,- (maandelijks) |

**Waarop zijn de maandelijkse kosten gebaseerd?**
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.
Lost van hosting verwachten we naar aanleiding van eerdere ervaringen dat de frontend 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.
## Koppeling op zaaksysteem
Het is mogenlijk om de Open WOO Website rechtstreeks aan uw zaaksysteem te koppelen aan de hand van ZGW of een Search endpoint (in het geval van zaaksysteem.nl)
## Koppeling op zaaksysteem

Het is mogelijk om de Open Woo Website rechtstreeks aan uw zaaksysteem te koppelen aan de hand van ZGW of een Search endpoint (in het geval van zaaksysteem.nl)

| Dienst | Kosten |
|----------------------------------------------|------------------------|
| Implementatie koppelvlak | €3000,- (eenmalig) |
| SAAS | €250,- (maandelijks) |

| Implementatie koppelvlak | € 3000,- (eenmalig) |
| SAAS | € 250,- (maandelijks) |

> **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. Andere koppelvlakken en maatwerk zijn uiteraard bespreekbaar, neem daarvoor contact op met een leverancier.
## 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.
## Configuratie 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 gebruikmaken van een Consultant.

| Dienst | Kosten |
|------------------------------|------------------------|
| Installatie en configuratie WOO-index integratie | €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: [email protected]. Wij gaan graag in gesprek over de mogelijkheden hiervoor!
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: <[email protected]>. Wij gaan graag in gesprek over de mogelijkheden hiervoor!

0 comments on commit 97bf677

Please sign in to comment.