Home

Met ReSpec maak je online gestructureerde documentatie. Bijvoorbeeld over datastandaarden of gegevenprofielen.

Architectuur ReSpec

De ReSpec-publicatie-architectuur bij CROW bestaat uit deze repositories.

1. stichting-crow/stichting-crow.github.io

   Configureerbare startpagina voor standaarden en technische documenten. docs.crow.nl is geconfigureerd als de URL voor deze voorkant.

2. stichting-crow/respec

   Host de ReSpec JavaScript-code, met een Stichting-CROW profiel. Laad deze met https://cdn.jsdelivr.net/gh/stichting-crow/respec@latest/builds/respec-stichting-crow.js.

3. stichting-crow/respec-design

   Host ook ondersteunende bestanden (CSS) voor ReSpec, met aanvullingen voor het Stichting-CROW profiel.

4. stichting-crow/respec-repo-template

   Bevat een GitHub-repository-sjabloon om snel een specificatie in CROW-ReSpec-stijl te maken. Dit sjabloon wordt gekopieerd naar nieuwe repos waarin de specificaties zelf komen. Het werkt samen stichting-crow/respec-document-template.

5. stichting-crow/respec-document-template

   Bevat het cookiecutter-sjabloon om snel een specificatie in CROW-ReSpec-stijl te maken. Dit sjabloon wordt uitgevoerd bij bestaande of nieuwe repositories, door middel van GitHub Actions.

6. stichting-crow/respec-workflows-template

   Bevat het cookiecutter-sjabloon voor de GitHub Actions workflows. Dit sjabloon wordt uitgevoerd bij nieuwe repositories, door stichting-crow/respec-repo-template. In bestaande repo's kan het helpen met het upgraden naar de laatste stand der automatisering.

Aanpassingen

Er zijn enkele aanpassingen gedaan op ReSpec voor CROW. Configuratie-opties die specifiek voor W3C-processen zijn bijvoorbeeld weggehaald. De pagina's in de zijbalk beschrijven de configuratieopties.