search

VNG-Realisatie / ODS-Open-Raadsinformatie

Project repository tbv de ontwikkeling van de Open Raads- en Stateninformatie API specificatie
https://vng-realisatie.github.io/ODS-Open-Raadsinformatie/
9 stars 2 forks source link

Catalogus lijkt te ontbreken #94

Closed lmasrarsaml closed 3 months ago

lmasrarsaml commented 4 months ago

Op de pagina 'Informatiemodel' is een link opgenomen naar de Catalogus Open Raads- en Stateninformatie, maar deze link is dood. Wordt er nog een catalogus toegevoegd met uitleg over de betekenis van alle termen in het model?

HenriKorver commented 4 months ago

Bij mij werkt deze link https://vng-realisatie.github.io/ODS-Open-Raadsinformatie/catalog. Welke link gebruik jij?

rien333 commented 4 months ago

Hier staat de niet-werkende link waar op gedoeld wordt: https://github.com/VNG-Realisatie/ODS-Open-Raadsinformatie/blob/243adbec4f6fe73e4054382e13f9ebf7b2dde2eb/docs/Informatiemodel.md?plain=1#L31

Maar als ik het goed begrijp zouden we de documentie het best niet in dit markdown bestand, maar op vng-realisatie.github.io kunnen raadplegen:

Bij mij werkt deze link https://vng-realisatie.github.io/ODS-Open-Raadsinformatie/catalog

HenriKorver commented 4 months ago

@rien333 Ja inderdaad kun je deze link het best raadplegen op vng-realisatie.github.io.

@melsk-r Is het mogelijk om de link naar de catalogus ook op GitHub zelf werkbaar te krijgen?

melsk-r commented 4 months ago

Ik zal kijken wat ik kan doen maar ik kan niets garanderen. De bestanden in de 'docs' folder zijn bedoelt om in GitHub Pages (github.io) te bekijken.

melsk-r commented 4 months ago

Zoals gezegd is het niet de bedoeling om een link in een document dat in de docs folder staat in GitHub te openen. De documenten die in die folder staan zijn bedoelt om de GitHub Pages site mee te genereren. De betreffende link zou wel omgezet kunnen worden naar een absolute url maar ook dan ga je voorbij aan waar de bestanden in de docs folder voor bedoelt zijn. Het nadeel van een absolute link is nl. dat als de repository onverhoopt hernoemd zou worden de link op de GitHub Pages site niet meer zou werken. Dat is n.m.m. dan ook niet verstandig om te doen vooral ook omdat dit niet de enige plaats is waar je een link van een absolute url zou moeten voorzien. Die site moet 100% correct gegenereerd kunnen worden onafhankelijk van de naam van de repository.

Ik zie overigens dat in de README.md in de root van de GitHub repo ook een link naar het bestand 'Informatiemodel.md' in de docs folder staat. Als je de inhoud van de README wil behouden zoals hij is zou je die link (maar ook enkele andere) helaas wel om moeten zetten naar een absolute link. Beter is echter de README aan te passen. Het is nu een 1 op 1 kopie van de index.html in de docs folder. Dat lijkt me een beetje overbodig. Ik denk dat het beter is om de README.md te voorzien van informatie over de functie van de repo en evt. nog wat uitleg over het werken in de repo en er daarnaast een link in op te nemen naar de GitHub Pages site van deze repo. Dat is weliswaar een absolute url maar het blijft dan beperkt tot 1 absolute url.