search

Geonovum / respec

A tool for creating technical documents and web standards. Geonovum fork to modify respec for own use.
Other
2 stars 1 forks source link

issueBase variabele genegeerd in config.js #187

Open wilkoquak opened 3 years ago

wilkoquak commented 3 years ago

In respec documenten wordt nog wel eens gebruik gemaakt van een issueBase variable om te verwijzen naar een plaats waar issues ingediend kunnen worden. Nu hebben we een standaard (IMGeluid) waar de issues in JIRA worden bijgehouden en daar wilden we dus via de issueBase verwijzen naar de JIRA helpdesk. Het lijkt er nu echter op dat die hele issueBase variabele genegeeerd wordt en dat altijd de issues pagina van het geconfigureerde github respository gebruikt wordt.

thijsbrentjens commented 3 years ago

Ook voor DSO een issue is, behoefte om met JIRA te werken

lvdbrink commented 3 years ago

Zijn dat dan openbare JIRA omgevingen, van IMGeluid en DSO? Over het algemeen zijn dat gesloten omgevingen, toch?

Van IMGeluid vind ik wel een Github issuelijst die gevuld is en waarop gereageerd is vanuit het werkveld, maar nergens een verwijzing naar een JIRA omgeving voor IMGeluid.

thijsbrentjens commented 3 years ago

Ik snap de wens wel dat je niet gebonden bent aan Github. Of het openbare issue trackers zijn, weet ik niet. Maar lijkt mij wel gewenst, het doc is openbaar als we het op docs.geostandaarden.nl publiceren.

lvdbrink commented 3 years ago

Ik snap de wens wel dat je niet gebonden bent aan Github. Of het openbare issue trackers zijn, weet ik niet. Maar lijkt mij wel gewenst, het doc is openbaar als we het op docs.geostandaarden.nl publiceren.

Sterker nog, het doc is ook al openbaar als werkversie op github. Dus idd gewenst om openbare issue trackers te gebruiken; als die er niet is zou je die link helemaal niet aan de gebruiker moeten aanbieden.

Ook eens met Thijs dat het natuurlijk niet per sé github hoeft te zijn. Maar let op, ReSpec ondersteunt alleen github, geen andere issue trackers. De issueBase parameter is onderdeel van de ReSpec-Github koppeling, die doorontwikkeld is ten opzichte van onze verouderde ReSpec fork... https://github.com/w3c/respec/wiki/github

thijsbrentjens commented 3 years ago

@gwolbers heeft een transformator geschreven, om een doc uit een word document te genereren. Theoretisch kan je dat ook zonder github gebruiken. Of dat gewenst is, in het kader van het beheerproces, is wat anders. Misschien onderdeel van discussie voor het standaardenoverleg

wilkoquak commented 2 years ago

Mijn oorspronkelijke issue is inmiddels opgelost: als je de github variabele uitcommentaart in config.js wordt de verwijzing naar github in je document weggelaten. Je kan dan zelf op een andere plek in je document een verwijzing zetten naar een helpdesk email adress.

De andere discussie die hier loopt is wel interessant en levert nu ook problemen om. Zo hebben we bij IMGeluid een helpdesk in JIRA en als er wijzigingsvoorstellen zijn (issues met de standaard) gaan die naar Github. Echter vaak is het zo dat iets als vraag over de standaard begint (helpdesk) en dan lanzamerhand blijkt er toch iets te moeten wijzigen in de standaard en dan maken we er een wijzigingsvoorstel van. Wat mij betreft is het onderscheid duidelijk.

Maar dan krijg je wel dat je in de standaard wilt zeggen:

Mijn vraag is nu: Hoe richten we dat in zodat we zo weinig mogelijk dubbel werk doen? Dit moeten we dus samen met beheer oplossen (@MVS11 heb jij hier ook gedachten over?)