Open proppy opened 4 months ago
I think the basic constraints/thinking that led to this kind of setup was:
Plus probably just "what seemed easy to do" / "automating what we were doing by hand". Other approaches are reasonable.
Note that this is also why we remap the g3doc folder to docs_src and render to docs/
(because that's where pages wants to look).
Didn't really want an automated rendering commit after every source change commit because it gunks up the commit history
I can definitly empathize w/ that!
The nice thing, now that github has https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow, is that we can publish directly from the workflow artefacts w/o commiting anything to main
or gh-pages
branches.
Cool, so long as there's a hosted site with docs I think it's all good options :-)
It seems that the current documentation process is not fully automated:
main
branch:@cdleary, @meheff any background on why things were setup that way?
We should consider streamlining the process w/ the following changes:
main
branch to https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflowstep
and thePAT
parameters frombuild-mkdocs-commit