carpentries / carpentries/workshop-template

Adding tutorial on how to customize the workshop template with the links to corresponding lessons

Open
#740 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
270
Forks
531
Avg merge
5d 6h
Merged PRs (30d)
1

Description

I was trying to set up my own template for a software carpentry to practice how to set a self organized workshop using your template. And it is very clear how you can customize your personal information and which setup to use based on the the type of carpentry, yet the lessons are not documented how to include them. Or at least , it is not clear at all from someone novice on how to tweak files on setting website templates , how to include the proper program of the lesson with the proper links to the material.
I figured it out a way by looking at (https://softwaresaved.github.io/2020-10-13-ssi-online/). In summary is including the syllabus.html inside the _include folder and in the index.md , then putting corresponding links in the schedule.html per carpentry lesson.You can see it in my copy of the template repo (https://github.com/leilaicruz/example-workshop-online)

This would be useful to get all the setup and the required material all in one place.
Just let me know if a pull request would be needed to integrate these changes in the template.

thanks!

Contributor guide

Open the contributing guide

Research direction

Review the template files _include/syllabus.html, index.md, and schedule.html, using the linked example workshop as a reference for how lessons and materials are connected. Check that the tutorial explains the customization steps and corresponding lesson links clearly enough for a novice to reproduce the setup.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.