GitHub pages

docs/Architectuur.md

@@ -1,3 +1,8 @@
+---
+layout: page-with-side-nav
+title: Ontwikkelversie Open Raadsinformatie
+---
+
 ![](RackMultipart20210319-4-1fq9oap_html_f2cf87d34556e0e2.gif)
 
 **NOTITIE**

docs/Designdecisions.md

@@ -1,3 +1,8 @@
+---
+layout: page-with-side-nav
+title: Ontwikkelversie Open Raadsinformatie
+---
+
 # Design decisions Open Raadsinformatie
 
 In de onderliggende Design Decisions zijn de inzichten vastgelegd die zijn opgedaan bij het ontwerpen en specificeren van API-specificatie voor Open Raadsinformatie.
@@ -28,7 +33,6 @@ _**Ratio : **_ Aangezien de er geen duidelijke User-stories vanuit gebruikersper
 
 ### 2 Modelleerkeuze voor resource "Informatieobject"
 
-De subtypes die in het informatiemodel onderkent zijn van het supertype "Informatieobject" zijn in het technische model gedenormaliseerd. De eigenschappen zijn opgenomen in de resource "Informatieobject" en er ise een property "InformatieObjectType" toegevoegd. 
+De subtypes die in het informatiemodel onderkent zijn van het supertype "Informatieobject" zijn in het technische model gedenormaliseerd. De eigenschappen zijn opgenomen in de resource "Informatieobject" en er ise een property "InformatieObjectType" toegevoegd.
 
 _**Ratio : **_ Deze wijze van technisch ontsluiten sluit beter aan bij het gebruik van deze gegevens dan het maken van allemaal aparte resources per subtype.
-

docs/Productvisie.md

@@ -1,3 +1,8 @@
+---
+layout: page-with-side-nav
+title: Ontwikkelversie Open Raadsinformatie
+---
+
 # Een transparante overheid
 
 ## Open (raads)informatie

docs/_config.yml

@@ -0,0 +1,44 @@
+
+baseurl: "/ODS-Open-Raadsinformatie"
+apiname: "Open Raadsinformatie"
+url: "http://localhost:4000"
+# nav is t.b.v. generatie side-navigation menu.
+# Een 'title' zonder path of url genereert slechts een kopje.
+# 'path' vormt tezamen met de baseurl de url waarmee de 'href' wordt gevuld.
+# Indien een 'url' voorradig dan wordt daarmee de 'href' gevuld en dient het path slechts om te bepalen welke link active is.
+# 'target: blank' zorgt er voor dat de link in een nieuw tabblad wordt geöpend.
+nav:
+  - title: Open Raadsinformatie
+    subnav:
+      - title: Main
+        path: /
+  - title: Specificaties v.2.0.0 (in ontwikkeling)
+    subnav:
+      - title: Documentatie
+        path: /v.1.2.0/Documentatie
+      - title: Open Raadsinformatie (swagger-ui)
+        path: /v.1.2.0/swagger-ui
+      - title: Open raadsinformatie (redoc)
+        path: /v.1.2.0/redoc
+  - title: Specificaties v.1.1.0
+    subnav:
+      - title: Documentatie
+        path: /v.1.1.0/Documentatie
+      - title: Open Raadsinformatie (swagger-ui)
+        path: /v.1.1.0/swagger-ui
+      - title: Open raadsinformatie (redoc)
+        path: /v.1.1.0/redoc       
+
+plugins:
+  - jekyll-redirect-from
+  - jekyll-remote-theme
+
+remote_theme: VNG-Realisatie/jekyll-theme-vng-realisatie
+
+github: VNG-Realisatie/ODS-Open-Raadsinformatie
+
+theme: jekyll-theme-time-machine
+
+project_name: /Open Raadsinformatie
+
+standard_family: VNG Realisatie

docs/index.md

@@ -0,0 +1,40 @@
+---
+layout: page-with-side-nav
+title: Ontwikkelversie Open Raadsinformatie
+---
+
+
+# ODS Open RaadsInformatie
+
+De Open API Specificatie voor Open Raadsinformatie beschrijft de standaard voor het ontsluiten van raadsinformatie van gemeenten.
+
+- De GitHub-repository bevindt zich [hier](https://github.com/VNG-Realisatie/ODS-Open-Raadsinformatie). 
+    - De "master" branch bevat release 1.1.0.
+    - De "develop" branch bevat versie 2.0.0-alpha.1 die nog in ontwikkeling is.
+- Opmerkingen, toevoegingen of voorstellen kunnen [hier als issue](https://github.com/VNG-Realisatie/ODS-Open-Raadsinformatie/issues) worden ingediend.
+
+<!--
+**Versie 1.1.0 is weliswaar gereleased, maar door ontwikkelingen rondom PLOOI en KOOP staat het gebruik ter discussie**
+**Ook de doorontwikkeling van versie 1.2.0 staat on hold tot er duidelijkheid is in de eisen die er in samenspraak met KOOp worden opgesteld.**
+**Proef-implementaties (en terugkoppeling van de bevindingen daaruit) zijn uiteraard wel mogelijk, maar de specificatie kan op dag-basis wijzigen.**
+**Als er een eerste stabiel versie is wordt daar een release van aangemaakt en wordt dit op deze plek (en via andere communicatie-lijnen) gedeeld.**
+-->
+
+## Documentatie
+* [Productvisie](./Productvisie.md)
+* [Hoe u kunt bijdragen](https://github.com/VNG-Realisatie/API-Kennisbank/blob/master/CONTRIBUTING.md)
+* [Architectuur](./Architectuur.md)
+* Ontwerpkeuzes staan in het document [Design decisions](./docs/Designdecisions.md)
+
+## Bronnen
+* Informatiemodel RSGB en Informatiemodel RGBZ
+* [Designrules Landelijke API strategie](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/)
+* [Extensions Landelijke API strategie](https://geonovum.github.io/KP-APIs/API-strategie-extensies/)
+
+## Contactpersonen:
+* Projectleider: Sander Bakker [email protected]
+* Architect: Ivo Hendriks [email protected]
+* API Designer: Henri Korver [email protected]
+
+## Licentie
+De koppelvlakstandaard, inclusief alle onderdelen die erbij horen (volgens productvisie en/of definition of done) zijn gelicenceerd onder [EUPL](https://eupl.eu/1.2/nl/).

docs/Catalogus03-2021.html → docs/v.1.1.0/Catalogus03-2021.html

@@ -52,15 +52,15 @@
                 </style>
    </head>
    <body>
-      <p>BASISMODEL
+     <div>BASISMODEL
          :
          Open Raads- en StatenInformatie
          :
          1.63.0
          :
-         2021-03-18T13:06:40Z</p>
-      <p>
-         ID: EAPK_85A44C13_58A2_4367_9A13_821BDB12E3B5</p>
+         2021-03-18T13:06:40Z</div>
+      <div>
+      ID: EAPK_85A44C13_58A2_4367_9A13_821BDB12E3B5</div><br/<br/>
       <div><strong>Domein: Model</strong><div>
             <h1>Objecttype overzicht </h1>
 

docs/v.1.1.0/Documentatie.md

@@ -0,0 +1,11 @@
+---
+layout: page-with-side-nav
+title: Ontwikkelversie Open Raadsinformatie
+---
+
+# Documentatie
+
+* [Informatiemodel](./Informatiemodel)
+* [Catalogus](./catalog)
+* [Technisch uitwisselingsmodel](./Uitwisselingsmodel)
+* Technische specificaties via [Redoc](./redoc) (Open API Specificaties en JSON schema) en via de [Swagger-interface](./swagger-ui)

docs/Informatiemodel.md → docs/v.1.1.0/Informatiemodel.md

@@ -1,3 +1,8 @@
+---
+layout: page-with-side-nav
+title: Ontwikkelversie Open Raadsinformatie
+---
+
 # Informatiemodel
 
 ## Inleiding
@@ -7,16 +12,15 @@ Open Raadsinformatie heeft als doel om gemeentelijke raadsinformatie, waaronder
 
 Het gaat hierbij om de semantiek en samenhang. De uitwerking naar een [technisch model](./Uitwisselingsmodel.md) is in een ander diagram uitgewerkt. In een technisch model kunnen andere keuzes gemaakt worden in de samenstelling van objecten (resources) en eigenschappen hiervan.
 
-De [Catalogus](./Catalogus03-2021.html) geeft gedetailleerd inzicht in het informatiemodel. 
+De [Catalogus](./Catalogus03-2021.html) geeft gedetailleerd inzicht in het informatiemodel.
 ## Scope
 
 Informatiemodel ORI is geen informatiemodel voor een RIS (RaadsInformatieSysteem) en ook niet van de huidige bestaande API van OpenRaadsinformatie, die ontstaan is uit de pilot in 2015. De scope van informatiemodel ORI is een weergave van de uitkomsten en agenda’s van vergaderingen van de gemeenteraad.
 
 ## Informatiemodel op hoofdlijnen:
 
-[![Informatiemodel op hoofdlijnen Open Raadsinformatie](./Open%20Raads-%20en%20StatenInformatie%20op%20hoofdlijnen.jpg)](https://github.com/VNG-Realisatie/ODS-Open-Raadsinformatie/blob/master/docs/Open%20Raads-%20en%20StatenInformatie%20op%20hoofdlijnen.jpg)
+<img src="./Open%20Raads-%20en%20StatenInformatie%20op%20hoofdlijnen.jpg" alt=" Informatiemodel Open Raadsinformatie op hoofdlijnen" width="1000"/>
 
 ## Informatiemodel volledig
 
-[![Informatiemodel volledig Open Raadsinformatie](./Open%20Raads-%20en%20StatenInformatie%20volledig.jpg)](https://github.com/VNG-Realisatie/ODS-Open-Raadsinformatie/blob/master/docs/Open%20Raads-%20en%20StatenInformatie%20volledig.jpg)
-
+<img src="./Open%20Raads-%20en%20StatenInformatie%20volledig.jpg" alt=" Informatiemodel Open Raadsinformatie volledig" width="1000"/>

docs/Uitwisselingsmodel.md → docs/v.1.1.0/Uitwisselingsmodel.md

@@ -1,14 +1,20 @@
+---
+layout: page-with-side-nav
+title: Ontwikkelversie Open Raadsinformatie
+---
+
 # Uitwisselingsmodel
 
 ## Inleiding
 
 Het technisch uitwisselingsmodel is een weergave van de entiteittypen (resources) zoals die in de API-specificatie beschreven worden en hun onderlinge samenhang.
 
-In dit model zijn alle resources van het informatiemodel opgenomen. Echter in fase 1 (Versie 1.1. van de API-specificatie) worden alleen de groen gekleurde resources ontsloten. Dat wil zeggen dat alleen der resources "vergaderingen", "agendapunten" en "informatieobjecten" ontsloten worden. 
+In dit model zijn alle resources van het informatiemodel opgenomen. Echter in fase 1 (Versie 1.1. van de API-specificatie) worden alleen de groen gekleurde resources ontsloten. Dat wil zeggen dat alleen der resources "vergaderingen", "agendapunten" en "informatieobjecten" ontsloten worden.
 
 Door op de image te klikken wordt er een nieuw tabblad van uw browser geopend met een beter leesbaar (en scrollbaar) formaat.
 
-De weergave van het technisch informatiemodel is op 21-06-2021 aangepast. Het bleek dat er een verouderde versie van het model was gepubliceerd. 
-Deze weergave is in overeenstemming met de releasecandidate van de standaard. 
+De weergave van het technisch informatiemodel is op 21-06-2021 aangepast. Het bleek dat er een verouderde versie van het model was gepubliceerd.
+Deze weergave is in overeenstemming met de releasecandidate van de standaard.
 
-[![Uitwisselingsmodel Open Raadsinformatie](./UGM%20Open%20Raadsinformatie.jpg)](https://github.com/VNG-Realisatie/ODS-Open-Raadsinformatie/blob/master/docs/UGM%20Open%20Raadsinformatie.jpg)
+<!--[![Uitwisselingsmodel Open Raadsinformatie](./UGM%20Open%20Raadsinformatie.jpg)](./UGM%20Open%20Raadsinformatie.jpg)]-->
+<img src="./UGM%20Open%20Raadsinformatie.jpg" alt=" Uitwisselingsmodel Open Raadsinformatie" width="1000"/>

docs/v.1.1.0/catalog.md

@@ -0,0 +1,7 @@
+---
+layout: page-with-side-nav
+head_include: include-htm.html
+title: catalog
+---
+
+<div data-include="https://melsk-r.github.io/ODS-Open-Raadsinformatie/v.1.1.0/Catalogus03-2021.html"></div>

docs/v.1.1.0/redoc.md

@@ -0,0 +1,7 @@
+---
+layout: page-with-side-nav
+title: redoc
+body_include: redoc-body.html
+spec-url: https://raw.githubusercontent.com/VNG-Realisatie/ODS-Open-Raadsinformatie/master/specificatie/genereervariant/openapi.yaml
+---
+<redoc spec-url='{{ page.spec-url}}'></redoc>

docs/v.1.1.0/swagger-ui.md

@@ -0,0 +1,8 @@
+---
+layout: page-with-side-nav
+title: swagger-ui
+head_include: swagger-ui-head.html
+body_include: swagger-ui-body.html
+openapi-url: https://raw.githubusercontent.com/VNG-Realisatie/ODS-Open-Raadsinformatie/master/specificatie/genereervariant/openapi.yaml
+---
+<div id="swagger-ui"></div>