search

Logius-standaarden / respec

A tool for creating technical documents and web standards
https://respec.org/
Other
1 stars 4 forks source link

Is het mogelijk 'Laatste werkversie' niet te tonen? #67

Open melsk-r opened 7 months ago

melsk-r commented 7 months ago

Zover ik kan nagaan wordt 'Laatste werkversie' altijd getoond en bevat dat de github.io url van de Respec project repository. Ik vraag me af of het wel altijd gewenst is dat deze getoond wordt.

In de Respec project repository werk je aan een nieuwe versie van de Respec documentatie die niet altijd in een keer goed en compleet zal zijn. Sterker nog dat zal bijna nooit het geval zijn. Na het maken van een wijziging in die repository wordt er echter wel altijd meteen een nieuwe versie van de github.io site gegenereerd die dan ook meteen via 'Laatste werkversie' in alle versies van de gepubliceerde Respec documentatie te benaderen is. Is dat wel zo handig of heb ik ergens iets gemist? Is het niet handig een configuratie mogelijkheid te hebben om 'Laatste werkversie' niet te tonen of is die er al?

sanderke commented 7 months ago

Het is mogelijk de "Laatste werkversie" naar een custom URL te laten verwijzen met edDraftURI. Wanneer dit een lege string is zal "Laatste werkversie" niet getoond worden:

edDraftURI: "",

Zelf werken wij met branches waar (grotere) wijzigingen in verwerkt worden. Wanneer deze gereed zijn worden ze gemerged met de werkversiebranch.

melsk-r commented 7 months ago

Het is mogelijk de "Laatste werkversie" naar een custom URL te laten verwijzen met edDraftURI. Wanneer dit een lege string is zal "Laatste werkversie" niet getoond worden:

edDraftURI: "",

Mooi, dat ga ik proberen.

Zelf werken wij met branches waar (grotere) wijzigingen in verwerkt worden. Wanneer deze gereed zijn worden ze gemerged met de werkversiebranch.

Het is natuurlijk het beste om met een of meer development branches te werken. Nadeel daarvan is dat je in GitHub maar 1 branch kunt aanwijzen die verwerkt wordt tot github.io. Tenminste dat is tot nu toe mijn ervaring. Je kunt dus niet meteen zien waar je wijzigingen toe leiden in het Respec document. Vaak geen probleem maar soms wel lastig.

melsk-r commented 7 months ago

Het is mogelijk de "Laatste werkversie" naar een custom URL te laten verwijzen met edDraftURI. Wanneer dit een lege string is zal "Laatste werkversie" niet getoond worden:

edDraftURI: "",

Werkt als een zonnetje maar wijkt de werking dan niet af van wat hier beschreven staat?

lvdbrink commented 7 months ago

Even een reactie op de oorspronkelijke vraag / deel van de vraag...

Zover ik kan nagaan wordt 'Laatste werkversie' altijd getoond en bevat dat de github.io url van de Respec project repository. Ik vraag me af of het wel altijd gewenst is dat deze getoond wordt.

ReSpec is oorspronkelijk bedoeld voor het maken van (beschrijvingen van) standaarden en ontstaan bij het W3C. Daar is de gewoonte om de werkversie van het document altijd te tonen, zodat de belanghebbenden bij de standaard altijd kunnen meekijken, tijdens het maakproces. Het open, transparant ontwikkelen van standaarden heeft als grote voordeel dat je vertrouwen wekt en belanghebbenden de gelegenheid geeft om mee te denken en kijken.

Er zijn natuurlijk situaties waarin je dit niet wilt, maar voor het maken van standaarden zou ik altijd adviseren om de werkversie open beschikbaar te stellen.

melsk-r commented 7 months ago

Dank je voor je reactie Linda en in principe ben ik het ook met je eens hoor. Ik wilde deze vraag echter binnen onze organisatie stellen maar dat heeft weinig zin als je 'Laatste werkversie' sowieso al niet kunt verbergen.