ReSpec-repo-template

A GitHub repository template for CROW-style ReSpec documents, to be used for technical specifications.

• Voor een nieuw project: volg onderstaand stappenplan.
• Voor een nieuw document binnen een bestaand project: volg het stappenplan op stichting-crow/respec-document-template.

Stappenplan nieuwe ReSpec

In het kort: standaardbranch: main; branch gh-pages wordt automatisch geactiveerd door .github/workflows/setup.yaml; Documenten komen in docs/, die map wordt gekopieerd en gedeployed. Het eerste werkdocument heeft dezelfde naam als de repo; referentieversies komen in gh-pages:v/, naast werkdocumenten.

1. Bedenk een korte naam voor het project.

   Een korte naam bestaat uit kleine letters, cijfers en koppeltekens.

   Dit wordt ook de naam van de GitHub-repository. informatiemodel beheer openbare ruimte: imbor, datastandaard fietsparkeren: datastd-fietspark, standaard uitwisselingsformaat globale visuele weginspectiebestanden in RDF: stufweg-rdf, etc.

2. Bedenk of werkversies en discussies niet-openbaar moeten zijn.

   Het wordt aanbevolen om werkversies publiek te bewerken. Openbare repositories zijn ook altijd gratis. Let op dat alle voorgaande versies van een document in GitHub altijd terug te halen zijn. Opmerkingen, wachtwoorden, etc. blijven in principe* altijd beschikbaar.

3. Klik op Use this template.

   Bij owner: ‘stichting-crow’ of de GitHub-organisatie van je werkgroep.
   Bij repository name: de korte naam van het project.
   Bij public/private: Als je het niet zeker weet, kies public.
   Bij include all branches: Niet noodzakelijk.

Vervolgens maakt GitHub een nieuwe repository aan, kopieert-ie de inhoud van stichting-crow/respec-repo-template en start-ie het aanmaken van het eerste document binnen de repo. Dat duurt zo'n 30 seconden, waarna het lampje in de balk bovenin op groen springt.

---

Documentation of the workings of stichting-crow/respec-repo-template

This repository is set as a GitHub template repository. After clone in the interface, a clone-event is sent to the GitHub Actions in this repository and setup.yaml triggers. That file will not run if the current repository is its base, preventing the automation from triggering before clone.

setup.yaml will then do the following:

1. Setup the GitHub Pages branch (gh-pages) and enforce HTTPS.
2. Run (with cookiecutter) the stichting-crow/respec-document-template, stichting-crow/respec-workflows-template templates.
3. Save version info on the used templates in .github/VERSION.
4. Overwrite the README with one for the spec / spec editors.