You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Dit hoofdstuk beschrijft hoe je een ReSpec document publiceert op: docs.geostandaarden.nl.
3
+
Dit hoofdstuk beschrijft hoe je een ReSpec document publiceert op: <https://docs.geostandaarden.nl> en gebeurt in de volgende stappen:
4
+
5
+
1. Geef het document de juiste status en vul de bijbehorende velden in.
6
+
2. Controleer of het document klaar is voor publicatie.
7
+
3. Check het document in op GitHub.
8
+
4. Druk in GitHub op de release knop.
9
+
5. Na succesvolle publicatie:
10
+
- zet de `specStatus` in `config.js` terug op `"wv"`
11
+
- Vul `previousMaturity` met de gepubliceerde `specStatus`
12
+
- Vul `previousPublishDate` in met de datum `publishDate`
13
+
14
+
Stap 4 zorgt voor een pull request op <https://github.com/Geonovum/docs.geostandaarden.nl>. Eén van de reviewers Frank Terpstra, Linda van den Brink of Wilko Quak checkt de publicatie.
15
+
Als alles goed is bevonden wordt het document vervolgens automatisch gepubliceerd op
## Geef het document de juiste status en vul de bijbehorende velden in.
19
+
20
+
### Consultatieversie (cv)
21
+
22
+
Controleer de volgende velden in `js/config.js`:
23
+
24
+
-`specStatus`:`"cv"
25
+
-`publishDate`: moet ingevuld zijn met de datum van publicatie van de. `"jjjj-mm-dd"`
26
+
-`shortname` : moet ingevuld zijn.
27
+
- Als er al eerder een versie gepubliceerd is moet daarnaar verwezen worden via het invullen van `Previousmaturity` en `previousPublishDate`.
28
+
29
+
30
+
### Vastellingsversie versie (vv)
31
+
32
+
- specStatus: "vv"
33
+
- publishDate: moet ingevuld zijn met de datum van publicatie van de
34
+
consultatieversie. "jjjj-mm-dd",
35
+
- Shortname: moet ingevuld zijn met korte naam voor het document. Dit wordt
36
+
onderdeel van de URL. Moet uniek zijn binnen pubdomain (afgezien van
37
+
versies).
38
+
- Als er al eerder een versie gepubliceerd is moet daarnaar verwezen worden via het invullen van `Previousmaturity` en `previousPublishDate`.
39
+
40
+
41
+
### Definitieve versie (def)
42
+
43
+
- specStatus: "def",
44
+
- publishDate: de publicatiedatum van de definitieve versie. "jjjj-mm-dd",
45
+
- Als er al eerder een versie gepubliceerd is moet daarnaar verwezen worden via het invullen van `Previousmaturity` en `previousPublishDate`.
46
+
47
+
48
+
**Noot:**
49
+
Automatisch publiceren werkt alleen in Github repositories waar, conform de [werkwijze](./index.md#respec-via-markdown), maar één ReSpec document in staat. Als er meerdere Respec documenten in een repository staan kun je [handmatig publiceren](#handmatig-publiceren-van-respec-document).
4
50
5
-
## Controles voor publicatie
6
51
7
-
Publicatie is grotendeel geautomatiseerd als aan de volgende voorwaarden is voldaan:
52
+
## Is het document publicatieklaar?
53
+
54
+
Publicatie is geautomatiseerd als aan de volgende voorwaarden is voldaan:
8
55
9
56
- de folderstructuur van de repository waarin het ReSpec document staat, moet conform de [Geonovum ReSpec template](https://github.com/Geonovum/NL-ReSpec-template) zijn
10
57
- dat wil zeggen, `index.html` in de root folder, `config.js` in `/js` folder, afbeeldingen in `/media` en/of `/data/Images` folder;
11
58
- de github repository mag maar één ReSpec document bevatten.
12
59
13
60
In het proces wordt op het volgende gecontroleerd:
14
-
- Controleer op **WCAG** (web toegankelijkheids-) regels. Bij het pushen van een ReSpec document naar
61
+
62
+
- Controle op **WCAG** (web toegankelijkheids-) regels. Bij het pushen van een ReSpec document naar
15
63
GitHub wordt automatisch een WCAG rapport geschreven. Dit is te vinden onder
16
64
'Actions'. Kies hier de commit die je gedaan hebt en je ziet daar
17
65
'build/WCAG Accessibility Check'). Deze controle checkt ook de HTML.
18
-
-Controleer op **Broken links**. Bij het pushen van een ReSpec document naar
66
+
-Controle op **Broken links**. Bij het pushen van een ReSpec document naar
19
67
GitHub wordt automatisch op broken links gecontroleerd. Dit is te vinden onder
20
68
'Actions'. Kies hier de commit die je gedaan hebt en je ziet daar
21
69
'Build/Link validation').
22
70
23
71
24
-
## Actie voor publiceren van een Consultatie versie (CV)
25
72
26
-
1. In 'js/config.js':
27
-
-`specStatus`:`"cv"`
28
-
-`publishDate`: moet ingevuld zijn met de datum van publicatie van de. `"jjjj-mm-dd"`,
29
-
-`Shortname`: moet ingevuld zijn met korte naam voor het document. Dit
30
-
wordt onderdeel van de URL. Moet uniek zijn binnen pubdomain (afgezien van
31
-
versies).
32
-
- Als er al eerder een versie gepubliceerd is (stabiele versie, dus
33
-
afgezien van de werkversie in github), kan Respec bovenin een document
34
-
de navigatie naar vorige versie goed genereren. Daarvoor moet je ook
35
-
invullen:
36
-
-`Previousmaturity`: wat de status toen was.
37
-
-`previousPublishDate`: wat de status toen was.
38
-
2. Commit je wijzigingen en push de commit.
39
-
3. Maak op github een Release. De automatische workflow maakt dan een pull request voor
- Vul previousPublishDate in met de datum van de zojuist gepubliceerde
101
-
definitieve versie
102
-
103
-
104
-
**Noot:**
105
-
Automatisch publiceren werkt alleen in Github repositories waar, conform de [werkwijze](./index.md#respec-via-markdown), maar één ReSpec document in staat.
106
-
107
-
Als er meerdere Respec documenten in een repository staan kun je [handmatig publiceren](#handmatig-publiceren-van-respec-document).
108
-
109
-
## Automatisch publiceren via de workflow
74
+
## Publiceer Automatisch
110
75
111
76
De automatische workflow gaat aan het werk bij elke keer dat je een Release aanmaakt in github. De stappen om een ReSpec document te publiceren naar docs.geostandaarden.nl via de workflow zijn als volgt:
112
77
@@ -125,7 +90,6 @@ De automatische workflow gaat aan het werk bij elke keer dat je een Release aanm
125
90
Meer documentatie staat in de readme van [NL-ReSpec-template](https://github.com/Geonovum/NL-ReSpec-template?tab=readme-ov-file#automatische-checks-en-build).
126
91
127
92
128
-
129
93
### Configureren van de automatische workflow
130
94
131
95
Bij het maken van een nieuw ReSpec document via de [template](https://github.com/Geonovum/NL-ReSpec-template) wordt de workflow automatisch geïnstalleerd. In github repositories die al een ReSpec document hadden voordat de nieuwe publicatieworkflow werd geïntroduceerd, is de workflow meestal ook al geinstalleerd. Alle actieve repositories waar een 'js/config.js' in gevonden is, hebben de nieuwe workflow gekregen.
@@ -168,4 +132,4 @@ Het ‘handmatige’ publicatieproces voor docs.geostandaarden.nl is als volgt:
168
132
169
133
- Docs.geostandaarden.nl is een mirror van: <https://github.com/Geonovum/docs.geostandaarden.nl/>
170
134
- Handmatige publicaie bestaat nu uit het rechtstreeks wijzigen van dit reopsitory. Maak in dit geval een pull request voor het repository en laat het goedkeuren zoals hierboven beschreven.
171
-
- In extreme gevallen kunnen beheerders ook zonder pull request wijzigingen doorvoer. In dat geval moet <docs.geostandaarden.nl> handmatig gesynchroniseerd worden. Dat kan via <https://github.com/Geonovum/docs.geostandaarden.nl/actions/workflows/deploy.yml> . Hier zie je een knopje: ‘Run workflow’.
135
+
- In noodgevallen kunnen beheerders ook zonder pull request wijzigingen doorvoeren. In dat geval moet <docs.geostandaarden.nl> handmatig gesynchroniseerd worden. Dat kan via <https://github.com/Geonovum/docs.geostandaarden.nl/actions/workflows/deploy.yml> . Hier zie je een knopje: ‘Run workflow’.
0 commit comments