VNG-Realisatie / VNG-R-Respec-Organization-configurations

VNG-R global configurations repository voor Respec
https://vng-realisatie.github.io/VNG-R-Respec-Organization-configurations/
Other
0 stars 0 forks source link

Kunnen we ons vinden in de repository waarin we Respec documentatie publiceren? #15

Open melsk-r opened 5 months ago

melsk-r commented 5 months ago

Op dit moment wordt de configuration property 'nl_organisationPublishURL' in de organization configuration gedefinieerd met de waarde 'https://vng-realisatie.github.io/publicatie'. Dat betekent dat we al onze gegenereerde Respec documentatie naar de repository 'publicatie' kopiëren. Alle VNG-R Respec documentatie is dan terug te vinden onder de url 'https://vng-realisatie.github.io/publicatie'. Kunnen we ons vinden in die url of heeft een andere toch de voorkeur?

Indien we besluiten een custom domain te gaan gebruiken maakt het niet meer uit in welke repository we onze Respec documenten plaatsen. Deze zijn dan immers terug te vinden onder de custom domain url. Dat heeft echter nog wel wat voeten in de aarde en behoeft n.m.m. een plan van aanpak.

hdksi commented 3 months ago

Ik vind publicatie niet heel duidelijk omdat alle pagina's binnen dat domein gepubliceerde inhoud beschrijven. Maar ik heb geen heel sterk alternatief paraat. spec zou kunnen, maar andere repo's/pagina's beschrijven óók specificaties. Een verwijzing naar modellen ligt vanwege eventuele publicatie van artefacten met een ander karakter evenmin voor de hand...

melsk-r commented 2 months ago

Lijkt me dat we maar z.s.m. een custom domain name moeten regelen. Ik heb daarover het volgende gedeeld met de collega's van Obelix:

In mijn presentatie over Respec enkele weken geleden gaf Ad in een reactie aan dat we ook maar eens moesten kijken of we een andere domeinnaam konden gaan gebruiken dan 'https://vng-realisatie.github.io'. Om een voorbeeld te noemen niet meer https://vng-realisatie.github.io/ODS-Open-Raadsinformatie/ maar:

Ik heb navraag gedaan bij Henri Kaper naar de regels die er binnen de VNG zijn voor het aanvragen van zo'n custom domeinnaam. Hij mag zoals ik al verwachtte niet zomaar een nieuw domein registreren. Dat moet in overleg met hoofd communicatie en mag alleen als er een goede reden voor is.

Mijn vraag aan jullie is welke domeinnaam we naar jullie mening zouden moeten gaan gebruiken? In verband met de éénwording wordt het domein 'vngrealisatie.nl' niet meer gebruikt dus de bovenstaande eerste optie valt sowieso al af. 'vng.nl' is natuurlijk wel toegestaan, dat domein is immers al in beheer bij de VNG. De vraag is alleen of we, als we voor die optie gaan, niet iets verder moeten verbijzonderen zoals in het derde voorbeeld hierboven. Of vinden we dat er toch een geheel ander custom domeinnaam moet worden aangevraagd. In dat geval hoor ik ook graag de argumenten van jullie.

Ik hoor graag hoe jullie hier tegenaan kijken en of we ook nog de mening van mijn standaardisatie collega's moeten vragen of dat dit iets is wat de Obelix groep mag beslissen.

Nadat ik van jullie een of meer keuzes heb ontvangen zal ik met Henri Kaper bekijken of dit te realiseren is. Tenzij jullie kiezen voor een 'vng.nl' adres, in dat geval zal ik met Alwin Zegers nagaan of de keuzes mogelijk zijn.

markbacker commented 2 months ago

Voor de SDG invoervoorziening gebruiken we bijvoorbeeld het domein https://pdc.vng.nl/ (en https://pdc-acc.vng.nl/ voor de acceptatieomgeving)

We zouden dan als domeinnaam https://standaarden.vng.nl/ kunnen kiezen. Dan wordt het https://standaarden.vng.nl/publicatie/ODS-Open-Raadsinformatie/. Publicatie ertussen voegt inhoudelijk niet echt iets toe, maar is dan voor technische redenen noodzakelijk. Je zou er een inhoudelijke groepering van kunnen maken. Bijvoorbeeld https://standaarden.vng.nl/api/ en https://standaarden.vng.nl/im/. Vereist wel dat je respec publiceert in twee repositories. Heeft dit meerwaarde?

Lijkt mij een stabiele en goed leesbare URL

melsk-r commented 2 months ago

@markbacker Ik vraag me af of we de repositorynaam niet ook nog kunnen verbergen in de url. Dat zou voorkomen dat we met 2 verschillende publicatie repositories moeten werken. Dat heeft nl. niet mijn voorkeur omdat:

Om bovenstaande voorstel te bereiken hoef je dan alleen maar de folders 'api' en 'im' in de publicatie repo te plaatsen. Bij de inrichting van de publicatie repo komen nog een aantal andere issues om de hoek kijken. Ik heb @hdksi in issue #17 al voorgesteld om dit nog samen te bespreken wellicht goed als je daarbij aanhaakt.

Lijkt me goed om hier even energie in te steken zodat we voorkomen dat we uiteindelijk belanden in een chaos.

melsk-r commented 2 months ago

Zie ook issues #16, #17 en #21.