Skip to content

Commit

Permalink
Merge branch 'main' of github.com:OpenCatalogi/.github
Browse files Browse the repository at this point in the history
  • Loading branch information
rubenvdlinde committed Aug 5, 2024
2 parents 95452d2 + 7266775 commit 7783abb
Show file tree
Hide file tree
Showing 9 changed files with 205 additions and 188 deletions.
49 changes: 22 additions & 27 deletions .github/ISSUE_TEMPLATE/Architectuur.yml
Original file line number Diff line number Diff line change
@@ -1,60 +1,55 @@
name: Architectuur vraag
description: Request a feature
title: "[feature]: As a user I want ....."
labels: [feature-request]
name: Architectuur Vraag/Voorstel
description: Stel een vraag of doe een voorstel over de standaard
title: "[architectuur]: Als een [gebruikersrol] wil ik [functionaliteit], zodat [waardetoevoeging]"
labels: [architecture]
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/)
Voordat je een nieuwe vraag stelt of een voorstel indient, controleer dan eerst onze backlog om duplicaties te voorkomen. We structureren onze user stories in een [agile formaat](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
- Vermeld de *Wie* in de titel. Bijvoorbeeld, `Als een gebruiker wil ik ...`
- Verwerk de *Wat* ook in de titel. Bijvoorbeeld, `... een duidelijke standaard`
- Definieer de *Waarom* in de eerste alinea van de 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.
We waarderen de tijd die je neemt om een vraag te stellen of een voorstel te doen. Om de verwerking te versnellen, hebben we bepaalde details nodig.
- 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..
placeholder: "Dus ...."
label: Wat is het doel van je vraag of voorstel? Waarom is het noodzakelijk?
description: Geef een duidelijke en nauwkeurige beschrijving van het probleem of de verbetering die je wilt adresseren.
validations:
required: true
- type: textarea
id: acceptance
attributes:
placeholder:|
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.
label: De acceptatiecriteria voor het voorstel
description: Beschrijf de voorwaarden waaraan moet worden voldaan om je vraag beantwoord of voorstel succesvol geïmplementeerd te beschouwen.
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?
label: Implementatiegebied
description: Waar moet deze wijziging plaatsvinden?
options:
- Startpagina(Homepage)
- Componenten overzicht (zoekpagina)
- Componenten detailpagina
- Organisatie detailpagina
- Documentatiepagina's
- Beheerschermen
- API
- Somewhere else (please specify in the description)
- Architectuurdocumentatie
- Standaardenoverzicht
- Iets anders (specificeer dit in de beschrijving)
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional context
description: Include any other pertinent details or screenshots related to the feature request.
label: Aanvullende context
description: Voeg alle andere relevante details of screenshots met betrekking tot je vraag of voorstel toe.
38 changes: 19 additions & 19 deletions .github/ISSUE_TEMPLATE/Functionaliteit.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Functionele vraag
description: Een vraag over bestaande of nieuwe functionaliteit van een Open Catalogi component
title: "[archicture]: As a user I want ....."
description: Een vraag over bestaande of nieuwe functionaliteit van een OpenCatalogi component
title: "[architectuur]: Als een [gebruikersrol] wil ik [functionaliteit], zodat [waardetoevoeging]"
labels: [feature-request]
assignees:
- rubenvdlinde
Expand All @@ -9,52 +9,52 @@ 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/)
Voordat je een nieuwe functie voorstelt, controleer dan eerst onze backlog om duplicaties te voorkomen. We structureren onze user stories in een [agile formaat](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
- Vermeld de *Wie* in de titel. Bijvoorbeeld, `Als een gebruiker wil ik ...`
- Verwerk de *Wat* ook in de titel. Bijvoorbeeld, `... een robuuste site map`
- Definieer de *Waarom* in de eerste alinea van de 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.
We waarderen de tijd die je neemt om een nieuwe functie voor te stellen. Om de verwerking van dit verzoek te versnellen, hebben we bepaalde details nodig.
- 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..
placeholder: "Dus ...."
label: Wat is het doel van je verzoek? Waarom is het noodzakelijk?
description: Geef een duidelijke en nauwkeurige beschrijving van het probleem dat je wilt aanpakken.
validations:
required: true
- type: textarea
id: acceptance
attributes:
placeholder:|
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.
label: De acceptatiecriteria voor de voorgestelde functie
description: Beschrijf de voorwaarden waaraan moet worden voldaan om je verzoek als succesvol geïmplementeerd te beschouwen.
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?
label: Implementatiegebied
description: Waar moet deze wijziging plaatsvinden?
options:
- Startpagina(Homepage)
- Startpagina
- Componenten overzicht (zoekpagina)
- Componenten detailpagina
- Organisatie detailpagina
- Documentatiepagina's
- Beheerschermen
- API
- Somewhere else (please specify in the description)
- Iets anders (specificeer dit in de beschrijving)
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional context
description: Include any other pertinent details or screenshots related to the feature request.
label: Aanvullende context
description: Voeg alle andere relevante details of screenshots met betrekking tot het functieverzoek toe.
42 changes: 21 additions & 21 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Bug report
description: File a bug report
name: Bugrapport
description: Meld een bug
title: "[Bug]: "
labels: [bug]
assignees:
Expand All @@ -9,56 +9,56 @@ body:
- type: markdown
attributes:
value: |
Before opening a bug report, please search for the behaviour in the existing issues.
Voordat je een bugrapport opent, zoek dan eerst naar het gedrag in de bestaande issues.
---
Thank you for taking the time to file a bug report. To address this bug as fast as possible, we need some information.
Bedankt dat je de tijd neemt om een bugrapport in te dienen. Om deze bug zo snel mogelijk op te lossen, hebben we wat informatie nodig.
- type: input
id: os
attributes:
label: Operating system
description: "Which operating system do you use? Please provide the version as well."
label: Besturingssysteem
description: "Welk besturingssysteem gebruik je? Geef ook de versie op."
placeholder: "macOS Big Sur 11.5.2"
validations:
required: true
- type: dropdown
id: component-location
attributes:
label: Project Location
description: Where did you find the bug?
label: Projectlocatie
description: Waar heb je de bug gevonden?
options:
- Frontend
- Backend
- Somewhere else (please specify in the description!)
- Iets anders (specificeer dit in de beschrijving!)
validations:
required: true
- type: dropdown
id: installation
attributes:
label: Instalation Location
description: Where is the project located?
label: Installatielocatie
description: Waar is het project geïnstalleerd?
options:
- Local
- Remote
- Somewhere else (please specify in the description!)
- Lokaal
- Extern
- Iets anders (specificeer dit in de beschrijving!)
validations:
required: true
- type: textarea
id: bug-description
attributes:
label: Bug description
description: What happened?
label: Bugbeschrijving
description: Wat gebeurde er?
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to reproduce
description: Which steps do we need to take to reproduce this error?
label: Stappen om te reproduceren
description: Welke stappen moeten we nemen om deze fout te reproduceren?
- type: textarea
id: logs
attributes:
label: Relevant log output
description: If applicable, provide relevant log output. No need for backticks here.
render: shell
label: Relevante log-output
description: Indien van toepassing, geef relevante log-output. Geen backticks nodig hier.
render: shell
3 changes: 1 addition & 2 deletions .github/workflows/openCatalogi.yaml

Large diffs are not rendered by default.

53 changes: 25 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,53 @@
# Wat is Open Catalogi?
Open Catalogi bestaad uit vier onderdelen
# Wat is OpenCatalogi?

1. **Een standaard** voor het federatief delen en vinden van gegevens
2. **Open Source componenenten** en applicaties die invulling geven aan die standaard
3. **Projecten** die gebruik maken van deze componenten
4. **Een organisatie** die al deze dingen coördineerd
OpenCatalogi bestaat uit vier onderdelen

**De Standaard**
We gaan 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. Het federatief stelsel wordt daarmee gefaciliteerd door catalogi die onderling samenwerken
1. **Een (architectuur)standaard** voor het federatief delen en vinden van gegevens
2. **Open Source componenten** en applicaties die invulling geven aan die standaard
3. **Projecten** die gebruik maken van deze componenten
4. **Een organisatie** die al deze dingen coördineert

![UML Diagram van OpenCatalogi](https://raw.githubusercontent.com/OpenCatalogi/.github/main/docs/handleidingen/components_simple.svg "UML Diagram van OpenCatalogi")
**De Architectuur**
We gaan er vanuit dat een gebruiker bij een interface een zoekvraag stelt 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.

Voor een uitgebreide opzet over de interne werking van catalogi kunt u kijken in onder [standaard](/Docs/Standaard/).
![UML Diagram van OpenCatalogi](https://raw.githubusercontent.com/OpenCatalogi/.github/main/docs/handleidingen/components_simple.svg "UML Diagram van OpenCatalogi")

Het is de ambitie van Open catalogi om deze standaard Q2 2025 te laten opnemen op de standaarden lijst van forum standaardisatie.
Voor een uitgebreide opzet over de interne werking van catalogi kunt u kijken in onder [standaard](/Docs/Standaard/).

**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. Een [nextcloud app](https://github.com/ConductionNL/opencatalogi) faciliteert een gemakkelijke omgeving voor het beheren van catalogi en publicaties. ([Common Ground laag 1 & 2](https://componentencatalogus.commonground.nl/5-lagen-model))
2. Een [web app](https://github.com/OpenCatalogi/web-app) faciliteert de gebruikersinterface waarmee kan worden gezocht

Hiernaast hebben verschillende projecten ook nog hun eigen uitbreidingen en matadateringen, voor meer details kunt u kijken onder [componenten](Docs/Componenten/).
Hiernaast hebben verschillende projecten ook nog hun eigen uitbreidingen en metadateringen, voor meer details kunt u kijken onder [componenten](Docs/Componenten/).

**Projecten**

1. Software Catalogus
2. Generieke datalandschap
3. OpenWoo.app
1. OpenCatalogi Core ontwikkeling
2. Softwarecatalogus
3. Generieke datalandschap
4. OpenWoo.app

Voor meer details kunt u kijken onder [projecten](Docs/Projecten/).
Voor meer details kunt u kijken onder [projecten](Docs/Projecten/).

**Organisatie**
Open catalogi kent een kerngroep en community, deze gaan gemeenschapenlijk over de standaard en codebases
OpenCatalogi kent een kerngroep en community, deze gaan gemeenschappelijk over de standaard en codebases

Voor meer details kunt u kijken onder [organisatie](Docs/Organisatie/).
Voor meer details kan je kijken onder [organisatie](Docs/Organisatie/).

**Roadmap**

- Q3 2024
- Q4 2024
- Q1 2025
- Q2 2025, Open catalogi tot landelijke standaard
- Q2 2025

**Vragen/Problemen**
Heeft u vragen, opmerkingen, aanbevelingen of problemen met de architectuur van Open Catalogi of een van de door Open Catalogi beheerde componenten? Dien hem dan vooral in via [github](https://github.com/OpenCatalogi/.github/issues/new/choose).
Heeft u vragen, opmerkingen, aanbevelingen of problemen met de architectuur van OpenCatalogi of een van de door OpenCatalogi beheerde componenten? Dien hem dan vooral in via [GitHub](https://github.com/OpenCatalogi/.github/issues/new/choose).

**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.


Wil je snel aan de slag met Open Catalogi? Dan zijn er twee gemakkelijke 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 OpenCatalogi-app](https://github.com/ConductionNL/opencatalogi) gebruiken.
Loading

0 comments on commit 7783abb

Please sign in to comment.