Template for lab group handbook
Link to suggestion
https://github.com/cct-datascience/group-handbook-template
Targeted section
Repository templates
Describe your suggestion
This is a template repository for creating a lab group handbook using Quarto. It comes with customization to _quarto.yml, a GitHub action to deploy the book on GitHub pages, a research best practices section and code of conduct that are pretty well fleshed out, and discussion prompts for many other sections (lab expectations, onboarding, offboarding, authorship guidelines, etc.). The README contains (hopefully) complete instructions on how to get started and a youtube video of a workshop I gave on this template. I hope it makes it easy for lab groups to create a living document with guidelines, policies and procedures.
Checklist
- [x] checked if your suggestion is not already listed in Awesome Quarto list.
- [x] checked if it can fit in an existed section or suggest a new section and explain why your item does not fit into one and what would be the interest of your new section.
- [x] checked when it's a repository if it's maintained (archived repository will be rejected).
Thanks for the suggestion.
Any reason to not package this as Quarto project/template extension?
Cool, I didn't realize it was that easy to create a complicated template like this. I tested quarto use cct-datascience/group-handbook-template and it seems to get all the files, but doesn't install extension dependencies correctly and didn't install the .github/ folder with the github action or custom issue template. I'll open an issue to look into this, but probably won't have time to work on it for a while.
Indeed, hidden files are not supported. This was reported in the past either as an issue or discussion.
So you might be stuck with GitHub template for now.
The issue tracking this is:
- https://github.com/quarto-dev/quarto-cli/issues/9515