Skip to content

Commit

Permalink
standaard.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MWest2020 committed Jul 31, 2024
1 parent 9a0d0b7 commit 3c792a1
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 21 deletions.
55 changes: 37 additions & 18 deletions docs/Standaard.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,52 @@
# 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.
OpenCatalogi is een standaard die eigenlijk bestaat uit een verzameling van andere standaarden:

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
- [NL Gov 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](https://vng.nl/projecten/federatieve-service-connectiviteit-fsc)
- [DCAT](https://www.forumstandaardisatie.nl/open-standaarden/dcat)
- [APNL]()
- [NL API-strategie](https://docs.geostandaarden.nl/api/API-Strategie/)
- [MDTO](https://www.nationaalarchief.nl/archiveren/mdto)
- [Publiccode](https://publiccode.eu/nl/)
- [TOOI](<https://standaarden.overheid.nl/tooi>

* vanuit andere projecten, zo als de OpenWoo.app, zijn er ook andere interfaces op het federatief stelsel beschickbaar
Deze standaarden bescrhijven gemeenschappelijk hoe catalogi kunnen worden vormgegeven op een manier waardoor ze gezamenlijk één virtuele catalogus vormen. Hierdoor blijft de data bij de bron (organisatie) en zijn er geen landelijke indexen nodig. Aanvullingen op OpenCatalogi moeten dus ook altijd conform deze standaarden worden toegevoegd.

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.
De OpenCatalogi-standaard houdt dan verder in dat er:

1. Een API-standaard is voor het koppelen van catalogi
2. Een architectuur voor het gedrag van catalogi
3. Een [NL Design](https://nldesignsystem.nl/) React interface geboden kan worden voor het zoeken binnen het federatieve netwerk*
4. Een beheeromgeving het aanmaken en vullen van catalogi
5. Verschillende koppelingen (ZGW, GitHub, DCAT etc.) voor het vullen van de catalogi
6. Verschillende koppelingen (DROP, Plooi) voor het doorsturen van informatie vanuit de catalogi

- vanuit andere projecten, zoals de OpenWoo.app, zijn er ook andere interfaces op het federatief stelsel beschikbaar

Het project biedt daarmee zowel de mogelijkheid om te koppelen a.h.v API-standaarden en een volledige set aan open source componenten om meteen aan de slag te kunnen. 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.

Vanuit het OpenCatalogi-stelsel gaan we er vanuit dat:

1. een gebruiker bij een interface een zoekvraag stelt aan een catalogus
2. de catalogus maakt vervolgens gebruik van bij hem bekende andere catalogi voor het beantwoorden van de vraag.

Hierbij kan één organisatie meerdere catalogi hebben, maar 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).
Voor een uitgebreide opzet over de interne werking van catalogi, zie ook 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.
Vanuit de gedachte van een federatief stelsel is iedere deelnemer verantwoordelijk voor zijn/haar eigen inbreng aan installaties en interfaces. Toch is het handig als er zo nu en dan al een en ander draait om op terug te vallen. Vanuit de OpenCatalogi community worden daarom de volgende diensten ook als achtervang aangeboden.

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.
1. Op [opencatalogi.nl](https://opencatalogi.nl/) draait een instantie van de interface waarmee gezocht kan worden in het federatief netwerk. Hiermee maken we de data visueel en is het makkelijk te controleren of je publicaties goed doorkomen. Het is echter een uitgangspunt dat iedere organisatie haar eigen publicatie voorziening treft.
2. Op [opencatalogi.nl/catalogi](https://opencatalogi.nl/catalogi) geven we een visuele representatie van de landelijke directory zodat inzichtelijk is welke catalogi beschikbaar zijn.
3. Vanuit de landelijke instantie draaien we een catalogus [GitHub](https://Github.com) de gekoppeld is aan GitHub (voor het automatisch inzichtelijk maken van open source projecten).
4. Vanuit de landelijke instantie draaien we een catalogus [GitLab](https://gitlab.com) de gekoppeld is aan GitLab (voor het automatisch inzichtelijk maken van open source projecten).
4. Vanuit de landelijke instantie draaien we een catalogus [opencatalogi](https://opencatalogi.nl) waarmee we [metadata formats]() beschikbaar 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 voor gebruik. Zowel de frontend, als de gegevens, kunnen worden gehost op GitHub.
6 changes: 3 additions & 3 deletions profile/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ Meer informatie over installeren via Helm kan worden gevonden op de [helm](https

### Alternatieve installatieroute

In sommige gevallen is er meer behoefte aan controle over de installatie (bijvoorbeeld omdat er geen Kubernetes omgeving beschikbaar is) in dat geval kan gebruik worden gemaakt van een ‘kale’ Common Gateway instalatie, zie voor meer informatie over het installeren van de Common Gateway de [Common Gateway installatie handleiding](https://github.com/ConductionNL/commonground-gateway).
In sommige gevallen is er meer behoefte aan controle over de installatie (bijvoorbeeld omdat er geen Kubernetes omgeving beschikbaar is) in dat geval kan gebruik worden gemaakt van een ‘kale’ Common Gateway installatie, zie voor meer informatie over het installeren van de Common Gateway de [Common Gateway installatie handleiding](https://github.com/ConductionNL/commonground-gateway).

Omdat OpenCatalogi een Common Gateway plugin is kan je vervolgens simpelweg in de Common Gatewayy naar plugins navigeren, zoeken naar OpenCatalogi, en op installeren klikken.
Omdat OpenCatalogi een Common Gateway-plugin is kan je vervolgens simpelweg in de Common Gatewayy naar plugins navigeren, zoeken naar OpenCatalogi, en op installeren klikken.

## Bijwerken naar nieuwere versies

Expand Down Expand Up @@ -83,7 +83,7 @@ Het datamodel van OpenCatalogi is gebaseerd op Public Code, een Europese standaa

Lees meer

- [Het volledige datamodel](https://conduction.stoplight.io/docs/publiccode)
- [Het volledige datamodel](https://conduction.stoplight.io/docs/open-catalogi)
- [Afwijkingen ten opzichte van publiccode](https://github.com/OpenCatalogi/.github/discussions/10)

## Projectinrichting
Expand Down

0 comments on commit 3c792a1

Please sign in to comment.