Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
melsk-r opened this issue Jan 12, 2024 · 5 comments
Open

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

melsk-r opened this issue Jan 12, 2024 · 5 comments

Comments

@melsk-r
Copy link

melsk-r commented Jan 12, 2024

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
Copy link
Member

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
Copy link
Author

melsk-r commented Jan 12, 2024

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
Copy link
Author

melsk-r commented Jan 12, 2024

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
Copy link

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
Copy link
Author

melsk-r commented Jan 15, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants