Dit is de GitHub-repository voor ...
-
Werkversies
Werkversies worden continu gepubliceerd op `https://docs.crow.nl/{{repository-korte-naam}}/{{document-korte-naam}} (logboek op auto-publish).
-
Referentieversies
Bijvoorbeeld voor een review of consultatie; klik op Publiceer een bepaalde versie en vervolgens Run workflow.
-
Een nieuw document toevoegen
Bijvoorbeeld voor een conceptueel model, API-beschrijving of uitwisselingsformaat; klik op Voeg een nieuw document toe en kies Run workflow.
-
Publicatie op crow.nl
Voor op de startpagina van docs.crow.nl: zie de README van docs.crow.nl. Voor op crow.nl of de kennisbank: mail.
-
Werken met ReSpec
ReSpec biedt structuur en presentatiemogelijkheden voor technische specificaties. Zoals informatiemodellen, uitwisselingsstandaarden en API-documentatie.
ReSpec gebruikt GfM als Markdown-specificatie. Lees ter referentie de CROW-ReSpec-wiki en de algemene ReSpec-handleiding.
-
Werken met Git en GitHub
Er zijn talloze handleidingen voor Git en GitHub.
De webinterface van VS Code (druk op GitHub.com op .) of Visual Studio Code geïnstalleerd op je computer. Voor VS Code worden er ook aanbevolen extensies meegegeven in deze repository.
-
Bijlagen, zoals afbeeldingen
Gebruik SVG-bestanden, bijvoorbeeld bewerkt met draw.io.