search

Logius-standaarden / ReSpec-template

Other
2 stars 2 forks source link

Respec-template voor BZK #11

Closed sgort closed 2 years ago

sgort commented 2 years ago

Voor de publicatie van De LegitiMaat is gebruik gemaakt van het Logius Respec-template. De idee is om nu een BZK specifieke variant te maken.

Zonder compleet te zijn:

Laat me even weten wat de beste manier is om dit op te pakken. Een fork van deze repo bij BZK en daar een branch voor het nieuwe profiel? Of anders?

nicorikken commented 2 years ago

Pandoc is inderdaad in staat om .odt en .docx bestanden te generen. Ik herinner me uit mijn experimenten uit het verleden dat het dan handig is om een template bestand aan te bieden om een leesbare stijl over te houden.

Verder zou ik bestanden toevoegen die naar de buitenwereld communiceren over de publieke repository:

Zie hier een voorbeeld van die documenten in de praktijk van een repository van mijn werkgever: https://github.com/alliander-opensource/power-grid-model

sgort commented 2 years ago

Dank @nicorikken ! Appreciated. Verhuis binnenkort met regels.overheid.nl van gitlab naar github MinBZK. Probeer zo goed mogelijk vanaf start public code compliancy te hanteren. Eea inmiddels óók zichtbaar in github policy die ik bij ICTU hielp vormgeven.

sanderke commented 2 years ago

organisatie-specifiek profiel voor BZK en/of NL?

Deze repository bevat een basis ReSpec-document. De organisatiespecifieke zaken komen vanuit de ReSpec build met Logius-profiel dat vanuit index.html wordt aangeroepen: https://github.com/Logius-standaarden/ReSpec-template/blob/7077b4f7d93ef942cb92daad089fd0510f4df125/index.html#L10 In de ReSpec repository (fork van W3C) wordt aan het Logius-profiel gewerkt. Een BZK-variant zou in dezelfde repository kunnen leven zoals de bestaande profielen, dus branches of forks zijn niet noodzakelijk. Mogelijk wordt samen met Geonovum een nieuwe GitHub-organisatie opgesteld om de repository te huisvesten voor samenwerking. Als men in de tussentijd wil sleutelen aan een BZK-variant zou een fork van de Logius ReSpec repo aangeraden zijn.

scenario('s) voor koppeling publicatieserver

Door middel van GitHub Actions genereren wij een statische HTML pagina en PDF voor publicatie en het uitvoeren van controles (kleurcontrast e.d. voor WCAG en gebroken links). Vervolgstappen zullen afhankelijk zijn van de publicatieomgeving; ons script kopieert bijvoorbeeld de statische bestanden naar een publicatierepo dat dagelijks naar logius.nl getrokken wordt.

nicorikken commented 2 years ago

Als het vanuit één template kan werken is dat zeker makkelijker.

Verhuis binnenkort met regels.overheid.nl van gitlab naar github MinBZK.

@sgort Beetje offoptic, maar GitLab is tenminste nog (grotendeels) open source en GitHub totaal niet. Ik snap wel de wens om naar één platform te bewegen om het overzichtelijk te houden, maar dit lijkt mij een beweging de verkeerde kant op, ook volgens inkoopregels (open, tenzij). Common Ground is ook juist gevestigd op GitLab. Ik hoop dat er voor de overheid in de toekomst zelfs een eigen code-infastructuur komt (al dan niet uitbesteed) die beter aansluit bij publieke waarden.

sgort commented 2 years ago

I know @nicorikken , punt is dat MinBZK géén presence heeft op GitLab en wel op github. Ik sluit zelf niet per se uit dat we tzt een gitlab omgeving optuigen voor MinBZK en github verlaten. Maar daar ga ik uiteindelijk niet over. Ma spreek ik Koos Steenbergen weer. Die gaat over open source binnen BZK.

sgort commented 2 years ago

Van deze originele issue zijn aparte issues aangemaakt op https://github.com/Logius-standaarden/respec/issues Deze issue kan worden gesloten.