-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #361 from OpenCatalogi/edits-26042024
Edits 26042024
- Loading branch information
Showing
21 changed files
with
421 additions
and
155 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,12 @@ | ||
## Welkom bij de documentatie van open catalogi! | ||
## Welkom bij de documentatie van OpenCatalogi | ||
|
||
OpenCatalogi creëert een krachtig federatief systeem dat informatie verzamelt van verschillende overheidsorganisaties, deze indexeert en u de mogelijkheid biedt om deze index te gebruiken of uw eigen index te starten. Met behulp van API's en gestandaardiseerde dataformaten kunnen verschillende entiteiten hun informatie naadloos integreren in één federatieve catalogus. De React-frontend is gebaseerd op NL Design en kan worden aangepast aan de huisstijl van uw organisatie met behulp van Design Tokens. | ||
|
||
|
||
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. | ||
|
||
## Opzet | ||
De basismodule van Open Catalogi bestaat uit drie hoofdcomponenten: | ||
|
||
De basismodule van OpenCatalogi bestaat uit drie hoofdcomponenten: | ||
|
||
1. Een genetwerkte omgeving voor het uitwisselen van gegevens, met een eigen [zoekpagina](https://opencatalogi.nl/). | ||
2. Repositories die informatie leveren aan het netwerk (bijvoorbeeld [Open WOO](https://github.com/ConductionNL/woo-website-template)) en optioneel een eigen pagina hebben (bijvoorbeeld [https://openwoo.app/](https://openwoo.app/)). | ||
|
@@ -19,9 +19,15 @@ Met andere woorden, repositories en organisaties wisselen gegevens uit binnen he | |
In een meer geavanceerde opzet kunnen ook andere bronnen dan repositories worden gebruikt (zoals API's) en kunnen organisaties hun eigen knooppunten starten. Meer informatie hierover vindt u in de [architectuursectie](/docs/handleidingen/Architectuur.md). | ||
|
||
## Snelle Start | ||
|
||
Voor het beschikbaar stellen van publicaties of zelfs uw eigen catalogus heeft u geen eigen server nodig, maar wel een [GitHub-organisatie](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch) waarvan u de beheerder bent. | ||
|
||
**Om uw repository bekend te maken en vindbaar te maken:** | ||
|
||
De snelste manier is de URL van uw repository [hier](https://opencatalogi.nl/documentation/usage/) op te geven. Uw repository met uw componenten zijn dan (vrijwel) direct zichbaar. | ||
|
||
Wilt uw meer controle over het tonen van de componenten of extra informatie meegeven, dan is de de handmatige wijze is hieronder te volgen. | ||
|
||
1. Maak binnen uw repository een map met de naam `.github`, maak daarbinnen een map met de naam `workflows` aan en maak daarin een bestand met de naam `openCatalogi.yaml`. De volledige padnaam wordt dus `[uw repository naam]/.github/workflows/openCatalogi.yaml`. | ||
3. Plaats de volgende YAML-code in het bestand `openCatalogi.yaml`: | ||
|
||
|
@@ -48,13 +54,15 @@ jobs: | |
- name: Create een Productpagina | ||
uses: OpenCatalogi/[email protected] | ||
```` | ||
|
||
4. Voor extra configuratieopties en stappen kunt u kijken naar de [Product Page](https://github.com/marketplace/actions/create-an-product-page) en [Publiccode](https://github.com/marketplace/actions/create-or-update-publiccode-yaml) acties op Github. | ||
|
||
**Om uw organisatie bekend te maken en uw eigen catalogus te starten:** | ||
|
||
1. Zorg ervoor dat uw organisatie een repository heeft met de naam `.github`. | ||
2. Maak binnen deze repository een map met de naam `.github`, maak daarbinnen een map met de naam `workflows` aan en maak daarin een bestand met de naam `openCatalogi.yaml`. De volledige padnaam wordt dus `.github/.github/workflows/openCatalogi.yaml`. | ||
3. Plaats de volgende YAML-code in het bestand `openCatalogi.yaml`: | ||
|
||
````yaml | ||
name: My Open Catalogi Workflow | ||
|
||
|
@@ -78,6 +86,7 @@ jobs: | |
- name: Create an Open Catalogi page | ||
uses: OpenCatalogi/[email protected] | ||
```` | ||
|
||
4. Voor extra configuratieopties en stappen kunt u kijken naar de [Catalogi Page](https://github.com/marketplace/actions/create-an-open-catalogi-page) en [Publiccode](https://github.com/marketplace/actions/create-or-update-publiccode-yaml) acties op Github. | ||
|
||
Voor meer details, het installeren van een eigen index en het afschermen van toegang zie [Installatie](/docs/handleidingen/Installatie.md). | ||
|
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,15 @@ | ||
# Design Decisions | ||
|
||
## We gebruiken GitHub voor onze code en bestanden | ||
## We gebruiken GitHub voor onze code en bestanden | ||
|
||
GitHub is een veel gebruikte oplossing binnen Common Ground en biedt ons als open source project voldoende functionaliteit om ons project open en gratis te draaien | ||
|
||
## Alle code en documentatie word openbaar gemaakt onder EUPL licentie | ||
zie [](https://github.com/orgs/OpenCatalogi/discussions/27) | ||
## We baseren on op Public Code | ||
## Alle code en documentatie word openbaar gemaakt onder EUPL-licentie | ||
|
||
zie [de documentatie](https://documentatie.opencatalogi.nl/) | ||
|
||
## We baseren ons op Public Code | ||
|
||
### Afwijkingen | ||
|
||
### Afwijkingen | ||
- Aan het contract object is de property phone toegevoegd voor het vasthouden van telefoonnummers |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.