Skip to content

Commit cc0987e

Browse files
committed
Add documentation, incubator check
1 parent 28817e7 commit cc0987e

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

_extras/customization.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,25 @@ configure some site-wide variables and make the site function correctly:
3535
it will appear in the "jumbotron" (the gray box at the top of the page). This variable is also
3636
used for the title of the extra pages. The README contains [more information about extra pages](https://github.com/carpentries/workshop-template#creating-extra-pages).
3737

38+
### Slug Validation
39+
40+
For workshops teaching a core or mix and match curriculum, i.e.
41+
where `carpentry` is set to `swc`, `dc`, or `lc`, the website build
42+
will check that your repository name matches the Carpentries slug
43+
format - `YYYY-MM-DD-site[-online]`, e.g. `2024-05-07-oomza-online`.
44+
45+
**If your repository name does not match this format, the build will
46+
fail, and will direct you to rename your workshop website repository
47+
to a valid slug.** You will then need to commit a change to the repo
48+
to rebuild the site, e.g. adding a space or other inconsequential
49+
change to the `README.md`.
50+
51+
Workshop websites using `cp` or `incubator` will go through the same
52+
check, but the build will not fail if the repo name does not match
53+
the slug format. You will see a warning in the build output instead.
54+
55+
### Incubator lessons
56+
3857
For workshops teaching lessons in The Carpentries Incubator,
3958
i.e. where `carpentry` is set to `incubator`,
4059
you should uncomment the following three fields in

bin/workshop_check.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -420,7 +420,7 @@ def check_slug(reporter, filename, repo_dir):
420420
print(fail_msg.format(repo_name, slugfmt))
421421
sys.exit(1)
422422

423-
elif carpentry in ('cp'):
423+
elif carpentry in ('cp', 'incubator'):
424424
warn_msg = (
425425
'Website repository name `{0}` does not match the suggested slug format: `{1}`. '
426426
'If teaching a workshop which you are collecting surveys for or are submitting into AMY, '

0 commit comments

Comments
 (0)