Documentatie voorbeeld bij PR

[wvangerwen]

Bij het maken van een PR (en elke volgende commit) wil ik dat er een preview van de documentatie wordt gemaakt.

Hier een voorbeeld uitgewerkt; https://daiyi.co/blog/pr-previews-for-github-pages/#Create-a-new-static-site

Maar wij maken de documentatie net iets anders, dus even kijken hoe we dit het makkelijkst in kunnen richten.

Op deze branch staat dit al deels uitgewerkt. https://github.com/threedi/hhnk-threedi-plugin/tree/documentatie-workflow

Wellicht dat er nog een if statement op kan oid dat alleen bij wijzigingen dit gedaan wordt.

[d2hydro]

@wvangerwen, Ik vraag me af of dit het waard is; we maken een simple workflow complex. Reviewen van docs gaat simpel lokaal. Wanneer je mkdocs and mkdocs-material aan je env toevoegd, kun je de documntatie lokaal serveren met: mkdocs serve:

Dan kun je de docs openen met de url: http://127.0.0.1:8000/hhnk-threedi-plugin/

Ik stel voor:

• [ ] het bouwen en reviewen van documentatie vast te leggen in een md-file
• [ ] zorgen dat de build_documentation workflow runt bij mergen met main.

Is dat OK, of wil je iets anders?

[wvangerwen]

Top ik hoopte eigenlijk al dat het niet te complex hoefde te worden.

Kan je

• [ ] een .cmd maken die de de mkdocs serve aanzet?
• [ ] de environment.yml aanpassen zodat dit kan draaien?
• [ ] op srvota155 en srv514 de extra dependencies installeren

Ik snap het vastleggen in een md-file niet helemaal. Build_docs bij merge met main ljikt me prima.

Is nu sowieso nog beetje moeilijk met reviewen omdat je wilt commenten in de md, maar daar is niet echt een oplossing voor. Tenzij je het op github zelf doet in de PR, maar dat is dan weer lastig lezen omdat je geen voorbeeld hebt.

[wvangerwen]

Net even getest, maar gaat nog niet lekker. Kan je ook kijken of je op de documentatie branch een werkend voorbeeld kan krijgen?