Skip to content

Commit

Permalink
Merge pull request #225 from ConductionNL/README-links
Browse files Browse the repository at this point in the history
Readme links
  • Loading branch information
remko48 authored Jan 9, 2024
2 parents 59834bf + f19a12b commit f2ee5c9
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/product-page-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Deploy the Product Page to GitHub Pages
on:
push:
branches:
- main
- never

permissions:
contents: write
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,12 @@ Deze pagina kan rechtstreeks vanaf GitHub (serverless) of los op een eigen omgev

- 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 ([Open Online](https://www.dimpact.nl/nieuws/gemeente-vught-live-met-open-online)) Drupal installatie met de Open Woo plugin ([roadmap](https://openwoo.app/github/Roadmap/?link=https://github.com/ConductionNL/woo-website-template/blob/main/docs/Roadmap.md))
- Een los JSON-bestand dat de data bevat vanuit de repository ([roadmap](https://openwoo.app/github/Roadmap/?link=https://github.com/ConductionNL/woo-website-template/blob/main/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 bron zich aan de standaard houdt.
Meer details hierover vindt u onder [architectuur](/docs/Architectuur.md).
Meer details hierover vindt u onder [architectuur](https://openwoo.app/github/Architectuur/?link=https://github.com/ConductionNL/woo-website-template/blob/main/docs/Architectuur.md).

![Website Architectuur](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/components.svg "Website Architectuur")

Expand All @@ -91,8 +91,8 @@ Op dit moment wordt de OpenWoo.app al door een aantal organisaties gebruikt

## Architectuur

Wil je meer weten over de architectuur van de Open Woo-app en uit welke componenten het bestaat? Kijk dan op de [architectuur pagina](./docs/Architectuur.md).
Wil je meer weten over de architectuur van de Open Woo-app en uit welke componenten het bestaat? Kijk dan op de [architectuur pagina](https://openwoo.app/github/Architectuur/?link=https://github.com/ConductionNL/woo-website-template/blob/main/docs/Architectuur.md).

## Toekomstplannen

Er komen steeds meer toepassingen voor het publiceren van overheidsinformatie. Denk bijvoorbeeld aan het publiceren van datasets, algoritmes en besluiten. Deze toepassingen zullen in de toekomst ook onderdeel worden van de Wet Open Overheid. Daarom is het belangrijk dat de Open WOO App flexibel is en kan worden aangepast aan de veranderende behoeften van de overheid. Kijk voor meer informatie over onze ontwikkelplannen op de [roadmap](./docs/Roadmap.md)
Er komen steeds meer toepassingen voor het publiceren van overheidsinformatie. Denk bijvoorbeeld aan het publiceren van datasets, algoritmes en besluiten. Deze toepassingen zullen in de toekomst ook onderdeel worden van de Wet Open Overheid. Daarom is het belangrijk dat de Open WOO App flexibel is en kan worden aangepast aan de veranderende behoeften van de overheid. Kijk voor meer informatie over onze ontwikkelplannen op de [roadmap](https://openwoo.app/github/Roadmap/?link=https://github.com/ConductionNL/woo-website-template/blob/main/docs/Roadmap.md)
4 changes: 2 additions & 2 deletions docs/Architectuur.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Het is ook mogelijk om een bestaande Open Webconcept-omgeving te combineren met

- Er moet een integratievoorziening worden geïnstalleerd of afgenomen

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

### (Losse) Frontend met integratie

Expand Down Expand Up @@ -107,4 +107,4 @@ Het Woo Publicatie Object vormt de kern van zowel de Woo API als de Woo-website.

## Roadmap

Organisaties kunnen bijdragen aan de ontwikkeling van deze componenten door items aan te dragen, deze zelf op te pakken en uit te voeren, of door de uitvoering ervan te financieren. Voor het huidige overzicht, zie [Roadmap](/docs/Roadmap.md).
Organisaties kunnen bijdragen aan de ontwikkeling van deze componenten door items aan te dragen, deze zelf op te pakken en uit te voeren, of door de uitvoering ervan te financieren. Voor het huidige overzicht, zie [Roadmap](https://openwoo.app/github/Roadmap/?link=https://github.com/ConductionNL/woo-website-template/blob/main/docs/Roadmap.md).
4 changes: 2 additions & 2 deletions docs/Configuratie.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Om te zorgen dat de Open WOO Website goed werkt, is het belangrijk dat de onderl

## Gebruik variabelen

Centraal in de Open WOO Website staat het publicatieobject, het publicatieobject vertegenwoordigt een Woo-publicatie, zijnde een verzoek, besluit, convenant of overige (een definitie van het Woo-publicatieobject vind je onder [Architectuur](./Architectuur.md)).
Centraal in de Open WOO Website staat het publicatieobject, het publicatieobject vertegenwoordigt een Woo-publicatie, zijnde een verzoek, besluit, convenant of overige (een definitie van het Woo-publicatieobject vind je onder [Architectuur](https://openwoo.app/github/Architectuur/?link=https://github.com/ConductionNL/woo-website-template/blob/main/docs/Architectuur.md)).

**Zoekbalk**

Expand Down Expand Up @@ -56,7 +56,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. 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.
Hoewel we er vanuit gaan dat categorieën voldoen aan de onder <!-- [Algemene inrichting zaaksysteem]() --> 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

Expand Down
4 changes: 2 additions & 2 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ A. Het is wel mogelijk om de OpenWoo.app te koppelen aan een zaaksysteem zonder

**Q. Wat als ik een bron wilt toevoegen die nog niet wordt ondersteund?**

A. Voor nieuwe bronnen, of gewenste features kunt u een issue aanmaken op onze [GitHub-pagina](https://github.com/ConductionNL/woo-website-template/issues). Deze worden dan gereviewd door de stuurgroep en indien mogelijk toegevoegd aan de roadmap. Voor meer informatie over de stuurgroep, zie [Governance](./Governance.md).
A. Voor nieuwe bronnen, of gewenste features kunt u een issue aanmaken op onze [GitHub-pagina](https://github.com/ConductionNL/woo-website-template/issues). Deze worden dan gereviewd door de stuurgroep en indien mogelijk toegevoegd aan de roadmap. Voor meer informatie over de stuurgroep, zie [Governance](https://openwoo.app/github/Bestuur/?link=https://github.com/ConductionNL/woo-website-template/blob/main/docs/GOVERNANCE.md).

**Q. Kan ik worden ontzorgd?**

A. Ja, dat is mogelijk. Er zijn leveranciers voor zowel SAAS als Service Level Agreement(SLA) beschikbaar Zie [Kosten](./Kosten.md) voor meer informatie.
A. Ja, dat is mogelijk. Er zijn leveranciers voor zowel SAAS als Service Level Agreement(SLA) beschikbaar Zie [Kosten](https://openwoo.app/github/Kosten/?link=https://github.com/ConductionNL/woo-website-template/blob/main/docs/Kosten.md) voor meer informatie.
4 changes: 2 additions & 2 deletions docs/Installatie.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 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](https://openwoo.app/github/Kosten/?link=https://github.com/ConductionNL/woo-website-template/blob/main/docs/Kosten.md).

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.

Expand Down Expand Up @@ -43,7 +43,7 @@ Als je de Open Woo Website liever vanaf een eigen server draait, kan dat uiteraa
### 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 serverinstallatie in het `.env`-bestand in de Gatsby-rootmap. We ondersteunen de volgende configuratie-opties.
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](https://github.com/ConductionNL/woo-website-template/blob/main/.github/workflows/product-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 |
|---------------------------|-----------------------|---------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|------------------------------------------------------------------------------------------------|
Expand Down
2 changes: 1 addition & 1 deletion docs/Integratie.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Voor de API is een [redoc documentatie](https://redocly.github.io/redoc/?url=htt

### Voorbeelden

In het merendeel van de gevallen zult u een zoekvraag willen uitvoeren binnen de Woo-publicaties van OpenWoo.app, het endpoint daarvoor is: <https://api.gateway.commonground.nu/api/publicaties>. Er zijn 4 voor de hand liggende zoekparameters waarmee gezocht wordt (overige opties vind u terug in de [Redoc documentatie]()).
In het merendeel van de gevallen zult u een zoekvraag willen uitvoeren binnen de Woo-publicaties van OpenWoo.app, het endpoint daarvoor is: <https://api.gateway.commonground.nu/api/publicaties>. Er zijn 4 voor de hand liggende zoekparameters waarmee gezocht wordt (overige opties vind u terug in de [Redoc documentatie](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/oas.yaml)).

1. Op een of meerdere zoek woorden, b.v. `_search=test`
2. Op organisatie, dit gaat aan de hand van OIN (de volledige OIN-lijst vind u [hier](https://oinregister.logius.nl/oin-register)) b.v. `oin=00000001001299992000`
Expand Down
6 changes: 3 additions & 3 deletions docs/Productie.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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.
- (optioneel) Kies een [leverancier](https://openwoo.app/github/Kosten/?link=https://github.com/ConductionNL/woo-website-template/blob/main/docs/Kosten.md) 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
Expand Down Expand Up @@ -73,13 +73,13 @@ Aan de hand van de acties voor de opdrachtgever kan uw leverancier vervolgens aa
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]())
- Aanleveren PEN test (deze staat [hier](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/PENTEST-Raportage.pdf))

## 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)
- [ ] Doorlopen van de [Acceptatie tests](https://openwoo.app/github/Testscenario's/?link=https://github.com/ConductionNL/woo-website-template/blob/main/docs/Tests.md)
- [ ] 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)
Expand Down

0 comments on commit f2ee5c9

Please sign in to comment.