Merging changes in branch #66 yesterday exposed a bit of a vulnerability - The changes were reviewed locally and all looked fine. After approval and merge tomain the CI built the site but lost much of the default CSS styling that comes with a quarto site. Turned out that the strategy of gitignoring the docs folder didn't play ball with the new site structure, so the change in this branch patches that.
This vulnerability is something that other hosting services such as netlify allow you to avoid. In those services, you can use branch deployments to review hosted sites before merging to main. A quick google for 'github pages branch deployments' has not yielded any result, but it would be worth looking into whether we can get the same sort of functionality as what Netlify offer. Something like a review branch which pushes new site builds to an alternative site url.
Fixes #74
Motivation and Context
Patches CSS bug.
Type of change
CI update
Accessibility
NA
Advice for reviewer
Please note that you will not currently notice any problem on the hosted site. I temporarily updated the CI to build from this branch while I identified the cause of the styling bug.
Alternative approach to updating the gitignore was explored - using the quarto resources YAML field to 'tell' quarto that the site_libs folder is necessary and should be included in the rendered output. The site_libs folder is where the default quarto styling files get saved on render. This did not fix the problem.
Checklist:
[X] I have read the CONTRIBUTING.md guidance for raising pull requests
[X] I have followed the intended structure of this project
[X] I have performed a self-review
[X] I have used comments, particularly in hard-to-understand areas
[X] This pull-request meets the accessibility guidance provided in the contributing guidance.
Description/Contribution Summary
Merging changes in branch #66 yesterday exposed a bit of a vulnerability - The changes were reviewed locally and all looked fine. After approval and merge to
mainthe CI built the site but lost much of the default CSS styling that comes with a quarto site. Turned out that the strategy of gitignoring thedocsfolder didn't play ball with the new site structure, so the change in this branch patches that.This vulnerability is something that other hosting services such as netlify allow you to avoid. In those services, you can use branch deployments to review hosted sites before merging to main. A quick google for 'github pages branch deployments' has not yielded any result, but it would be worth looking into whether we can get the same sort of functionality as what Netlify offer. Something like a
reviewbranch which pushes new site builds to an alternative site url.Fixes #74
Motivation and Context
Patches CSS bug.
Type of change
Accessibility
NA
Advice for reviewer
Please note that you will not currently notice any problem on the hosted site. I temporarily updated the CI to build from this branch while I identified the cause of the styling bug.
Alternative approach to updating the gitignore was explored - using the quarto
resourcesYAML field to 'tell' quarto that thesite_libsfolder is necessary and should be included in the rendered output. Thesite_libsfolder is where the default quarto styling files get saved on render. This did not fix the problem.Checklist:
Additional comments