|
1 | | -# `template-workshop`: A template for creating Quarto-based workshops |
2 | | - |
3 | | -[](https://github.com/copier-org/copier) |
4 | | -[](https://results.pre-commit.ci/latest/github/rostools/template-workshop/main) |
5 | | -[](https://github.com/rostools/template-workshop/releases/latest) |
6 | | - |
7 | | - |
8 | | -Release |
9 | | -Zenodo DOI |
10 | | - |
11 | | -## Features |
12 | | - |
13 | | -- Uses [Quarto](https://quarto.org/) for the workshop content, allowing for easy |
14 | | - integration of code, text, and figures. |
15 | | -- Includes a [justfile](https://just.systems/man/en/) for managing common tasks |
16 | | - like building the workshop and running checks. |
17 | | -- Uses [typos](https://github.com/crate-ci/typos) to check for common |
18 | | - spelling mistakes. |
19 | | -- For R projects, uses [Air](https://posit-dev.github.io/air/) to format and check |
20 | | - R code. |
21 | | -- Uses [Commitizen](https://commitizen-tools.github.io/commitizen/) to check |
22 | | - commit messages, create the changelog, tag the repository, and create a |
23 | | - a GitHub release. |
24 | | -- Uses a [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/) license. |
25 | | -- Run checks with with [pre-commit](https://pre-commit.com/) hooks to ensure |
26 | | - consistent formatting and style across the project. It includes checks for |
27 | | - credentials, typos, and file formatting. |
28 | | -- Uses [rostools-theme]() Quarto extension for a standard appearance across |
29 | | - workshops. |
30 | | -- Includes [GitHub Actions](https://docs.github.com/en/actions) for continuous |
31 | | - integration and delivery for running checks, formatting, releasing, and building |
32 | | - the website. |
33 | | -- Uses [Netlify](https://www.netlify.com/) for hosting the workshop website, |
34 | | - which is automatically built and deployed with Quarto's GitHub Action workflow. |
35 | | -- Includes an [EditorConfig](https://editorconfig.org/) file to ensure consistent |
36 | | - formatting across different editors. |
37 | | -- Sets some common VS Code settings for the project, including suggesting |
38 | | - extensions |
39 | | - |
40 | | - |
41 | | -## Using |
42 | | - |
43 | | -This template uses [Copier](https://copier.readthedocs.io/) to create a folder |
44 | | -with relevant files for a rostools-structured workshop. We use |
45 | | -[uv](https://docs.astral.sh/uv) to run the commands, so you'll need to install |
46 | | -that first. After that, creating a new workshop project folder can be done with: |
47 | | - |
48 | | -```bash |
49 | | -uvx copier copy gh:rostools/template-workshop WORKSHOP-NAME |
50 | | -``` |
51 | | - |
52 | | -Where `WORKSHOP-NAME` is the name of the folder you want to create. This will |
53 | | -copy the template files into that folder, and you can then edit them as needed. |
54 | | -When you use it, it will ask you a series of questions to correctly set up the |
55 | | -workshop folder. |
| 1 | + |
| 2 | + |
| 3 | +# Template Workshop: An opinionated setup for making workshops as open educational resources |
| 4 | + |
| 5 | +<!-- TODO: DOI here --> |
| 6 | + |
| 7 | +[](https://github.com/copier-org/copier) |
| 8 | +[](https://github.com/rostools/template-workshop/blob/main/LICENSE.md) |
| 10 | +[](https://github.com/rostools/template-workshop/releases/latest) |
| 12 | +[](https://github.com/rostools/template-workshop/actions/workflows/test.yml) |
| 13 | +[](https://github.com/rostools/template-workshop/actions/workflows/build-website.yml) |
| 15 | +[](https://results.pre-commit.ci/latest/github/rostools/template-workshop/main) |
| 17 | +[](https://lifecycle.r-lib.org/articles/stages.html#experimental) |
| 18 | +[](https://www.repostatus.org/#active) |
| 21 | + |
| 22 | +This repository contains a template for setting up a new workshop |
| 23 | +repository that will contain files to create a website for a workshop |
| 24 | +and that might also be used as an open educational resource (OER). Use |
| 25 | +this template to quickly get started with a new workshop with all the |
| 26 | +necessary files and configurations in place for a smoother “developer |
| 27 | +experience” and to have [continuous |
| 28 | +delivery/deployment](https://en.wikipedia.org/wiki/Continuous_delivery) |
| 29 | +of the workshop website and archival to Zenodo. |
| 30 | + |
| 31 | +Check out our [website](https://template-workshop.rostools.org/) for |
| 32 | +more information, such as the features it provides, a |
| 33 | +[guide](https://template-workshop.rostools.org/docs/guide/) for using |
| 34 | +the template. For a list of changes, see our |
| 35 | +[changelog](https://template-workshop.rostools.org/docs/releases/) page. |
| 36 | + |
| 37 | +## Contributing |
| 38 | + |
| 39 | +Check out our [contributing |
| 40 | +page](https://template-workshop.rostools.org/contributing/) for |
| 41 | +information on how to contribute to the project, including how to set up |
| 42 | +your development environment. |
| 43 | + |
| 44 | +Please note that this project is released with a [Contributor Code of |
| 45 | +Conduct](https://github.com/rostools/template-workshop/blob/main/CODE_OF_CONDUCT.md). |
| 46 | +By participating in this project you agree to abide by its terms. |
| 47 | + |
| 48 | +## Licensing |
| 49 | + |
| 50 | +This project is licensed under the [MIT |
| 51 | +License](https://github.com/rostools/template-workshop/blob/main/LICENSE.md). |
| 52 | + |
| 53 | +## Citing |
| 54 | + |
| 55 | +This project is part of rostools, which is an organisation that hosts |
| 56 | +and runs workshops (also as open educational resources) that are related |
| 57 | +in some way to doing reproducible and open science. If you use this |
| 58 | +project in your work, please cite it as follows: |
| 59 | + |
| 60 | +Johnston L.W., Brødbæk S.K. Template Workshop: An opinionated setup for |
| 61 | +making workshops as open educational resources URL: |
| 62 | +https://template-workshop.rostools.org |
| 63 | + |
| 64 | +Or as a BibTeX entry: |
| 65 | + |
| 66 | + @misc{YourReferenceHere, |
| 67 | + author = {Johnston, Luke William and Brødbæk, Signe Kirk}, |
| 68 | + title = {Template Workshop: An opinionated setup for making workshops as open educational resources}, |
| 69 | + url = {https://template-workshop.rostools.org} |
| 70 | + } |
0 commit comments