Opschonen documentatie pagina

OpenCatalogi · Jul 31, 2024 · 41de7e0 · 41de7e0
1 parent 1d9d38a
commit 41de7e0
Show file tree

Hide file tree

Showing 9 changed files with 210 additions and 39 deletions.
diff --git a/.github/ISSUE_TEMPLATE/architecture.yml b/.github/ISSUE_TEMPLATE/architecture.yml
@@ -0,0 +1,60 @@
+name: Feature request
+description: Request a feature
+title: "[feature]: As a user I want ....."
+labels: [feature-request]
+assignees:
+  - rubenvdlinde
+  - RonaldvCortenberghe
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Before proposing a new feature, please ensure to double-check our backlog to avoid duplications. We structure our user stories in an[agile format](https://www.agilealliance.org/glossary/user-story-template/) 
+        
+        - Include the *Who* in the title. For instance, `As a user, I want …`
+        - Incorporate the *What* into the title as well. For example, `… a robust site map`
+        - Define the *Why* in the first paragraph of the user story
+        ---
+
+        We appreciate the time you've taken to suggest a new feature. To expedite the processing of this request, we need certain details.
+
+  - type: textarea
+    id: why
+    attributes:
+      placeholder: "So ...."
+      label: What is the purpose of your request? Why is it necessary?
+      description: Provide a clear and precise description of the issue you're aiming to address.. 
+    validations:
+      required: true
+  - type: textarea
+    id: acceptance
+    attributes:
+      placeholder:|
+        1. ...
+        2. ...
+        3. ...       
+      label: The acceptance criteria for the proposed feature
+      description: Detail the conditions that, if met, would mean your request has been successfully implemented.
+    validations:
+      required: true
+  - type: dropdown
+    id: component-location
+    attributes:
+      label: Implementation Area Include any other pertinent details or screenshots related to the feature request.
+      description: Where should this change occur?
+      options:
+        - Startpagina(Homepage)
+        - Componenten overzicht (zoekpagina)
+        - Componenten detailpagina
+        - Organisatie detailpagina
+        - Documentatiepagina's
+        - Beheerschermen
+        - API
+        - Somewhere else (please specify in the description)
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description:  Include any other pertinent details or screenshots related to the feature request.
diff --git a/.github/workflows/openCatalogi.yaml b/.github/workflows/openCatalogi.yaml
diff --git a/README.md b/README.md
@@ -1,44 +1,40 @@
 # Wat is Open Catalogi?
-Open Catalogi is een standaard die eigenlijk bestaad uit een versameling van andere standaarden (o.a.[NL Gog profile for cloud events](https://www.logius.nl/domeinen/gegevensuitwisseling/nl-gov-profile-cloudevents), [NL GOV profile for OAuth 2.0](https://www.forumstandaardisatie.nl/open-standaarden/nl-gov-assurance-profile-oauth-20) [FSC](), [DCAT](), [APNL](), [NL API strategie](), [MDTO](), [Publiccode](), [TOOI]()) de gemeenschappenlijk beschrijven hoe catalogusen kunnen worden vormgegeven op een manier waardoor ze gesamenlijk één virtuele catalogus vormen. Hierdoor blijdt de data bij de bron (organisatie) en zijn er geen landelijke indexen nodig. 
+Open Catalogi bestaad uit drie onderdelen
 
-1. Een API standaard voor het koppelen van catalogi
-2. Een architectuur voor eht gedrag van catalogi
-3. Een [NL Design]() react interface voor het zoeken binnen het federatieve netwerk*
-4. Een beheer omgeving het aanmaken en vullen van catalogi
-5. Verschillende koppelingen (ZGW, GGithub, Decat etc) voor het vullen van de catalogi
-6. Verschillende koppelingen (Drop, Plooi) voor het doorsturen van informatie vanuit de catalogi
+1. Een (architectuur) standaard voor het fereatief delen en vinden van gegevens
+2. Open Source componenent en applicaties die invulling geven aan die standaard
+3. Projecten de gebruik maken van deze componenten 
+4. Een organisatie die al deze dingen coördineerd
 
-* vanuit andere projecten, zo als de OpenWoo.app, zijn er ook andere interfaces op het federatief stelsel beschickbaar
-
-Het project bied daarmee zowel de mogenlijkheid om te koppelen a.h.v API standaarden en een volledige set aan open source componenten om meteen aan de slag te kunnen gaan. Hierbij is ook voorzien in de koppeling met het huidige landschap. 
-
-## Opzet
-Vanuit het Open Catalogi stelsel gaan we er vanuit dat een gebruiker bij een interface een zoekvraag steld aan een catalogus, de catalogus maakt vervolgens gebruik van bij hem bekende andere catalogi voor het beantwoorden van de vraag. Hierbij kan één organisatie meerdere catalogi hebben meer behoord iedere catalogus altijd bij één organisatie.
+## De Architectuur
+W gaan r vanuit dat een gebruiker bij een interface een zoekvraag steld aan een catalogus, de catalogus maakt vervolgens gebruik van bij hem bekende andere catalogi voor het beantwoorden van de vraag. Het federatief stelsel wordt daarmee gefaciliteerd door catalogi die onderling samenwerken
 
 ![UML Diagram van OpenCatalogi](https://raw.githubusercontent.com/OpenCatalogi/.github/main/docs/handleidingen/components_simple.svg "UML Diagram van OpenCatalogi")
 
 Voor een uitgebreide opzet over de interne werking van catalogi kunt u kijken in de [architectuursectie](/docs/handleidingen/Architectuur.md). 
 
-## Landelijke diensten
-Vanuit de gedachte van een federatief stelsel is iedere deelnemer verantwoornlijk voor zijn/haar eigen inbreng aan installaties en interfaces. Toch is het handig als er zo nu en dan al een en ander draaid om op terug te vallen. Vanuit de Open Catalogi community worden daarom de volgende diensten ook als achtervang aangeboden.
+## Componenten
+Vanuit de Open Catalogi gemeenschap worden een aantal open source componenten onderhouden en ontwikkeld die organisaties helpen met het implementeren van Open Catalogi, de belangrijkste daarvan zijn:
+
+1. Een [nextcloud app](https://github.com/ConductionNL/opencatalogi) faciliteerd een gemakkenlijke omgeving voor opslaan beheren van catalogi en publicaties. (commonground laag 1 & 2)
+2. Een [web app](https://github.com/OpenCatalogi/web-app) faciliteerd de gebruikers interface waarmee kan worden gezocht
 
-1. Op [opencatalogi.nl](https://opencatalogi.nl/) draaid een instantie van de interface waarmee gezocht kan worden in het federatief netwerk. Hiermee maken we de data visueel en is het makenlijk te controlleren of je publicaties goed doorkomen. Het is echter een uitgangspunt dat iedere organisatie haar eigen publicaite voorziening treft.
-2. Op [opencatalogi.nl/catalogi]() geven we een visuele representatie van de landelijke directory zodat inzichtenlijk is welke catalogi bechickbaar zijn.
-3. Vanuit de landelijke instantie draaien we een catolgus [github]() de gekopeld is aan github (voor het automatisch inzichtenlijk maken van open source projecten).
-4. Vanuit de landelijke instantie draaien we een catolgus [gitlab]() de gekopeld is aan gitlab (voor het automatisch inzichtenlijk maken van open source projecten).
-4. Vanuit de landelijke instantie draaien we een catolgus [opencatalogi]() waarmee we [metadata formats]() beschickbaar stellen voor hergebruik.
+Hiernaast hebben verschillende projecten ook nog hun eigen uitbreidingen en matadateringen
 
-Wat OpenCatalogi uniek maakt, is dat de frontend serverless (via GitHub) kan draaien, waardoor deelnemende organisaties OpenCatalogi niet zelf hoeven te installeren om het te kunnen gebruiken. Zowel de frontend als de gegevens kunnen worden gehost op GitHub.
+## Projecten
 
-## Varianten
-Hoewel Open Catalogi zich in princiepe leent voor het publiceren van alles (het besschrijft immers alleen een stelsel van samenwerkende catalogi) zien we binnen het poject een aantal varianten naar voren komen:
+1. Software Catalogus
+2. Generieke datalandschap
+3. OpenWoo.app 
 
-- **Software catalogus** Van oorsprong is het Open Catalogi als project begonnen om een alternatief te bieden voor de [commonground componenten vatalogus]() waarbij het niet langer noodzakenlijk is om infortmatie te brengen. In plaatsdaarvan wordt deze opgehaald aan de hand van een publiccode.yaml bestand.
-- **OpenWoo.app** Het doorzoekbaar maken van data t.b.v. (WOO)[]
-- **Datacatalogus** Het beschickbaar stellen van high value datasets voor de t.b.v. (WHO)[] 
+## Organisatie
+Open catalogi kent een kerngroep en community, deze gaan gemeenschapenlijk over de standaard en codebases
 
 ## Snelle Start
+Wil je snel aan de slag met Open Catalogi? Dan zijn er twee gemakkenlijke routes.
 
+1. Via https://opencatalogi.nl/ kan je zoeken binnen het federatieve stelsel van de aangesloten organisaties
+2. Als je wat dieper wilt duiken kan je de [nextcloud app](https://github.com/ConductionNL/opencatalogi) gebruiken.
 
 
 
diff --git a/docs/Componenten.md b/docs/Componenten.md
@@ -1 +1,3 @@
-# OpenCatalogi-Componenten
+# Title
+
+Dit is een test voor automatische PDF generatie
diff --git a/docs/GOVERNANCE.md b/docs/GOVERNANCE.md
@@ -14,7 +14,7 @@ Overheden en leveranciers kunnen op een aantal manieren bijdragen aan dit projec
 
 ## Deelname OpenCatalogi
 
-Als uw organisatie geïntreseerd is in deelname aan de OpenCatalogi-coalitie kunt u contact opnemen via [[email protected]]([email protected])
+Als uw organisatie geïntreseerd is in deelname aan de OpenCatalogi-coalitie kunt u contact opnemen via [[email protected]](mailto:[email protected])
 
 ## Deelnemers
 

diff --git a/docs/NavbarContent.json b/docs/NavbarContent.json
@@ -11,28 +11,54 @@
     }
   },
   {
-    "label": "Bijdragen",
+    "label": "Standaard",
     "type": "internalMarkdown",
     "current": {
-      "pathname": "/Docs/CONTRIBUTING"
+      "pathname": "/Docs/Standaard"
     },
     "handleClick": {
       "internalMarkdown": {
         "directoryName": "Docs",
-        "fileName": "CONTRIBUTING"
+        "fileName": "Standaard"
+      }
+    }
+  },
+  {
+    "label": "Componenten",
+    "type": "internalMarkdown",
+    "current": {
+      "pathname": "/Docs/Componenten"
+    },
+    "handleClick": {
+      "internalMarkdown": {
+        "directoryName": "Docs",
+        "fileName": "Componenten"
+      }
+    }
+  },
+  {
+    "label": "Projecten",
+    "type": "internalMarkdown",
+    "current": {
+      "pathname": "/Docs/Projecten"
+    },
+    "handleClick": {
+      "internalMarkdown": {
+        "directoryName": "Docs",
+        "fileName": "Projecten"
       }
     }
   },
   {
     "label": "Organisatie",
     "type": "internalMarkdown",
     "current": {
-      "pathname": "/Docs/GOVERNANCE"
+      "pathname": "/Docs/Organisatie"
     },
     "handleClick": {
       "internalMarkdown": {
         "directoryName": "Docs",
-        "fileName": "GOVERNANCE"
+        "fileName": "Organisatie"
       }
     }
   },

diff --git a/docs/Organisatie.md b/docs/Organisatie.md
@@ -1 +1,40 @@
 # Organisatie
+
+
+## Product Owner
+De day to day keuzes voor Open Catalogi worden gemaak door de product owner
+
+## Kerngroep
+
+## Coalitie
+De echte kracht achter het project wordt geleverd door een groep van overheden die bijdragen aan de doorontwikkeling met kennis, kunde en financien. De Coalitie komt ieder kwartaal fysiek bij elkaar om de lange termijn strategie te bepalen en evenuteele keuzes te maken.
+
+
+| Organisatie                                         | Type                 | 
+|-----------------------------------------------------|----------------------|
+| [Dimpact](https://www.dimpact.nl)                   | Samenwerkingsverband |
+| [Common Ground](https://commonground.nl/)           | Samenwerkingsverband | 
+| [Conxillium](https://www.conxillium.com)            | Leverancier          |
+| [Rotterdam](https://www.rotterdam.nl)               | Gemeente             | 
+| [Roermond](https://www.roermond.nl)                 | Gemeente             | 
+| [Assen](https://www.assen.nl)                       | Gemeente             | 
+| [Hilversum](https://www.hilversum.nl)               | Gemeente             | 
+| [Haarlemmermeer](https://haarlemmermeergemeente.nl) | Gemeente             | 
+| [Enschede](https://www.enschede.nl)                 | Gemeente             | 
+| [Eindhoven](https://www.eindhoven.nl)               | Gemeente             |
+| [Amersfoort](https://www.amersfoort.nl)             | Gemeente             | 
+| [Zwolle](https://www.zwolle.nl)                     | Gemeente             | 
+| [Hoorn](https://www.hoorn.nl)                       | Gemeente             | 
+| [Emmen](https://www.emmen.nl)                       | Gemeente             | 
+| [Harderwijk](https://www.harderwijk.nl)             | Gemeente             | 
+| [Leiden](https://gemeente.leiden.nl)                | Gemeente             | 
+| [Bronckhorst](https://www.bronckhorst.nl)           | Gemeente             | 
+| [Delft](https://www.delft.nl)                       | Gemeente             | 
+| [Open Webconcept](https://openwebconcept.nl/)       | Gemeente             | 
+| [Acato](https://www.acato.nl)                       | Leverancier          | 
+| [Conduction](https://www.conduction.nl)             | Leverancier          | 
+| [Shift2](https://www.shift2.nl/)                    | Leverancier          | 
+| [IO Digital](https://www.iodigital.com/nl/home)     | Leverancier          | 
+
+
+Als uw organisatie geïntreseerd is in deelname aan de OpenCatalogi-coalitie kunt u contact opnemen via [[email protected]]([email protected])
diff --git a/docs/Projecten.md b/docs/Projecten.md
@@ -1,10 +1,17 @@
 # Projecten
+Naast de generieke organisatie zijn er een aantal project groepen actief met (deel) projecten aan de hand van open catalogi.
 
-## OpenCatalogi Core
+## Software Catalogus
+**Product Owner**: [Ronald van Cortenberghe](mailto:[email protected])(Gemeente Rotterdam)
 
-## OpenCatalogi Softwarecatalogus
+## Generieke datalandschap
+**Product Owner**: [Ronald Kok](mailto:[email protected])(Gemeente Rotterdam)
 
-## OpenCatalogi PublicData
+## OpenWoo.app 
+**Product Owner**: [Ruben van der Linde](mailto:[email protected])(Conduction)
 
-## OpenWoo
+## Een deel project opstarten
+Wil je zelf aan de hand van open catalogi een eigen project opstarten? en hierbij terugleveren aan de open catalogi gemeenschap? Dan kan je een deel project opstarten. Neem daarvoor contact op met [[email protected]](mailto:[email protected]). Van een deel project verwachten we:
 
+- Bijdragen aan de algemene ontwikkeling van Open Catalogi
+- Aanwezigheid van de product owner bij de community meetings (ider kwartaal)
diff --git a/docs/Standaard.md b/docs/Standaard.md
@@ -1 +1,41 @@
-# De OpenCatalogi-Standaard
+# Standaard
+
+Open Catalogi is een standaard die eigenlijk bestaad uit een versameling van andere standaarden (o.a.[NL Gog profile for cloud events](https://www.logius.nl/domeinen/gegevensuitwisseling/nl-gov-profile-cloudevents), [NL GOV profile for OAuth 2.0](https://www.forumstandaardisatie.nl/open-standaarden/nl-gov-assurance-profile-oauth-20) [FSC](), [DCAT](), [APNL](), [NL API strategie](), [MDTO](), [Publiccode](), [TOOI]()) de gemeenschappenlijk beschrijven hoe catalogusen kunnen worden vormgegeven op een manier waardoor ze gesamenlijk één virtuele catalogus vormen. Hierdoor blijdt de data bij de bron (organisatie) en zijn er geen landelijke indexen nodig. 
+
+1. Een API standaard voor het koppelen van catalogi
+2. Een architectuur voor eht gedrag van catalogi
+3. Een [NL Design]() react interface voor het zoeken binnen het federatieve netwerk*
+4. Een beheer omgeving het aanmaken en vullen van catalogi
+5. Verschillende koppelingen (ZGW, GGithub, Decat etc) voor het vullen van de catalogi
+6. Verschillende koppelingen (Drop, Plooi) voor het doorsturen van informatie vanuit de catalogi
+
+* vanuit andere projecten, zo als de OpenWoo.app, zijn er ook andere interfaces op het federatief stelsel beschickbaar
+
+Het project bied daarmee zowel de mogenlijkheid om te koppelen a.h.v API standaarden en een volledige set aan open source componenten om meteen aan de slag te kunnen gaan. Hierbij is ook voorzien in de koppeling met het huidige landschap. 
+
+## Opzet
+Vanuit het Open Catalogi stelsel gaan we er vanuit dat een gebruiker bij een interface een zoekvraag steld aan een catalogus, de catalogus maakt vervolgens gebruik van bij hem bekende andere catalogi voor het beantwoorden van de vraag. Hierbij kan één organisatie meerdere catalogi hebben meer behoord iedere catalogus altijd bij één organisatie.
+
+![UML Diagram van OpenCatalogi](https://raw.githubusercontent.com/OpenCatalogi/.github/main/docs/handleidingen/components_simple.svg "UML Diagram van OpenCatalogi")
+
+Voor een uitgebreide opzet over de interne werking van catalogi kunt u kijken in de [architectuursectie](/docs/handleidingen/Architectuur.md). 
+
+## Landelijke diensten
+Vanuit de gedachte van een federatief stelsel is iedere deelnemer verantwoornlijk voor zijn/haar eigen inbreng aan installaties en interfaces. Toch is het handig als er zo nu en dan al een en ander draaid om op terug te vallen. Vanuit de Open Catalogi community worden daarom de volgende diensten ook als achtervang aangeboden.
+
+1. Op [opencatalogi.nl](https://opencatalogi.nl/) draaid een instantie van de interface waarmee gezocht kan worden in het federatief netwerk. Hiermee maken we de data visueel en is het makenlijk te controlleren of je publicaties goed doorkomen. Het is echter een uitgangspunt dat iedere organisatie haar eigen publicaite voorziening treft.
+2. Op [opencatalogi.nl/catalogi]() geven we een visuele representatie van de landelijke directory zodat inzichtenlijk is welke catalogi bechickbaar zijn.
+3. Vanuit de landelijke instantie draaien we een catolgus [github]() de gekopeld is aan github (voor het automatisch inzichtenlijk maken van open source projecten).
+4. Vanuit de landelijke instantie draaien we een catolgus [gitlab]() de gekopeld is aan gitlab (voor het automatisch inzichtenlijk maken van open source projecten).
+4. Vanuit de landelijke instantie draaien we een catolgus [opencatalogi]() waarmee we [metadata formats]() beschickbaar stellen voor hergebruik.
+
+Wat OpenCatalogi uniek maakt, is dat de frontend serverless (via GitHub) kan draaien, waardoor deelnemende organisaties OpenCatalogi niet zelf hoeven te installeren om het te kunnen gebruiken. Zowel de frontend als de gegevens kunnen worden gehost op GitHub.
+
+## Varianten
+Hoewel Open Catalogi zich in princiepe leent voor het publiceren van alles (het besschrijft immers alleen een stelsel van samenwerkende catalogi) zien we binnen het poject een aantal varianten naar voren komen:
+
+- **Software catalogus** Van oorsprong is het Open Catalogi als project begonnen om een alternatief te bieden voor de [commonground componenten vatalogus]() waarbij het niet langer noodzakenlijk is om infortmatie te brengen. In plaatsdaarvan wordt deze opgehaald aan de hand van een publiccode.yaml bestand.
+- **OpenWoo.app** Het doorzoekbaar maken van data t.b.v. (WOO)[]
+- **Datacatalogus** Het beschickbaar stellen van high value datasets voor de t.b.v. (WHO)[] 
+
+## Snelle Start