Logius-standaarden / respec

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

Request for tips! #64

Open melsk-r opened 10 months ago

melsk-r commented 10 months ago

Last weeks I have been looking at how we at VNG Realisatie can use the Logius Respec template. I have not yet finished my findings, but I have already processed them in the Readme of the VNG-R Respec template and in a first version of a Way Of Working document, the latter can also be viewed here.

I think I've come a long way, but I'm still running into some problems that are also preventing me from completing the description. In a test repository, the 'pages build and deployment' action is executed without any problems. However, no static HTML is yet generated that I can use to publish a specific version and generating a PDF is also not possible yet. See all workflow runs. Can someone help me with some tips?

sanderke commented 10 months ago

The log says: Permission to melsk-r/Respec-test.git denied to github-actions[bot]. The set-up in the template tries to push the static files back to the main branch of the same repo. Is your main branch perhaps protected?

melsk-r commented 10 months ago

I looked at it and it isn't. I wondered if the build process is somehow dependant of the configuration properties within configuration.js or organisation-config.js, e.g. the 'github' configuration property. Maybe that's the cause of my problems. On the other hand I can't imagine that, because Geonovum would already have run against problems with that before since they already use de Logius framework.

melsk-r commented 10 months ago

I've been playing with the 'workflows/build.yml' file. If I change the rule:

uses: Logius-standaarden/Automatisering/.github/workflows/build.yml@snapshot-in-repo

in

uses: Logius-standaarden/Automatisering/.github/workflows/build.yml@main

the job does get a step further. See the difference between the job before that change and the job after that change. I suppose '@snapshot-in-repo' refers to the branch 'snapshot-in-repo' which isn't present in my repository. Shouldn't that be changed within the Logius template repository or should I configure my repository further?

Unfortunately the 'Check' and 'Publish' steps still don't run succesfully after making the change described above. The 'Check' steps reveils a lot of errors that need a closer look. Disabling that step by removing it from the 'workflows/build.yml' file doesn't make the 'Publish' step run succesfully either. I hoped it would at least publish something but that step is skipped instead. Suppose it needs the 'Check' step.

melsk-r commented 10 months ago

Succeeded in taking the 'Check / WCAG' step, all errors in the HTML file were resolved. 'Check/Links' step still doesn't run succesfully as you can see below:

image

See this job.

@sanderke Dit zegt me niet zo veel, weet jij wat er nog fout gaat.

sanderke commented 10 months ago

I suppose '@snapshot-in-repo' refers to the branch 'snapshot-in-repo' which isn't present in my repository. Shouldn't that be changed within the Logius template repository or should I configure my repository further?

This is a branch of the github action, not your repo: https://github.com/Logius-standaarden/Automatisering/tree/snapshot-in-repo

The main branch of this action does not place output files back in the repo.

sanderke commented 10 months ago

Succeeded in taking the 'Check / WCAG' step, all errors in the HTML file were resolved. 'Check/Links' step still doesn't run succesfully as you can see below:

image

See this job.

@sanderke Dit zegt me niet zo veel, weet jij wat er nog fout gaat.

In organisation-config.js staat het volgende:

nl_organisationPublishURL: "https://github.com/melsk-r/gitdocumentatie",
latest: "Laatste",
latestVersion: ["nl_organisationPublishURL", "latest", "/", "shortName"],

Samen met shortName: "template" uit config.js komt dit neer op: https://github.com/melsk-r/gitdocumentatie/Laatste/template zoals in de screenshot. Dit is geen geldige URL.

Dit zijn de URL's die bovenaan de documenten staan ("Laatst gepubliceerde versie", e.d.) De opbouw verschilt per organisatie en is daarom vrij in te vullen, bij onze eigen documenten bijv.:

nl_organisationPublishURL: "https://gitdocumentatie.logius.nl/publicatie/",
latestVersion: ["nl_organisationPublishURL", "pubDomain", "/", "shortName"],

voorbeeldresultaat: https://gitdocumentatie.logius.nl/publicatie/dk/oin

https://github.com/Logius-standaarden/respec/wiki/latestVersion

melsk-r commented 10 months ago

This is a branch of the github action, not your repo: https://github.com/Logius-standaarden/Automatisering/tree/snapshot-in-repo

The main branch of this action does not place output files back in the repo.

Ok, changing '@main' back into '@snapshot-in-repo' however makes the job crash. What do you suggest?

melsk-r commented 10 months ago

Succeeded in taking the 'Check / WCAG' step, all errors in the HTML file were resolved. 'Check/Links' step still doesn't run succesfully as you can see below: image See this job. @sanderke Dit zegt me niet zo veel, weet jij wat er nog fout gaat.

In organisation-config.js staat het volgende:

nl_organisationPublishURL: "https://github.com/melsk-r/gitdocumentatie",
latest: "Laatste",
latestVersion: ["nl_organisationPublishURL", "latest", "/", "shortName"],

Samen met shortName: "template" uit config.js komt dit neer op: https://github.com/melsk-r/gitdocumentatie/Laatste/template zoals in de screenshot. Dit is geen geldige URL.

Dit zijn de URL's die bovenaan de documenten staan ("Laatst gepubliceerde versie", e.d.) De opbouw verschilt per organisatie en is daarom vrij in te vullen, bij onze eigen documenten bijv.:

nl_organisationPublishURL: "https://gitdocumentatie.logius.nl/publicatie/",
latestVersion: ["nl_organisationPublishURL", "pubDomain", "/", "shortName"],

voorbeeldresultaat: https://gitdocumentatie.logius.nl/publicatie/dk/oin

https://github.com/Logius-standaarden/respec/wiki/latestVersion

Ok, thank you. I'll try things out again.

sanderke commented 10 months ago

This is a branch of the github action, not your repo: https://github.com/Logius-standaarden/Automatisering/tree/snapshot-in-repo The main branch of this action does not place output files back in the repo.

Ok, changing '@main' back into '@snapshot-in-repo' however makes the job crash. What do you suggest?

This might help: https://stackoverflow.com/a/75308228