A lightweight framework for creating workshops using jekyll and markdown (mostly). The concept is a good workshop will consist of
- A strong hands on component, Apprentice is intended as a compnanion to that
- Good online material to refer to both before and after the workshop
- A brief presentation to orient attendees
- Good organization
The Apprentice framework is composed of 4 primary components.
- A home page with prequisites and objectives
- Online tutorial composed of units
- A slide deck for presentations
- Instructors notes
If you are familiar with Jekyll, you can probably get going using the steps below. There is also a more comprehensive tutorial and demo if you like.
- Fork the repository
- Edit
_config.yml
as described in the comments - Edit
_data/objectives.yml
and_data/prereqs.yml
to outline course objectives and prequisites. - Create, remove and edit files in
_units/
to create course units._units/overview.md
is documented with guidance. - Create, remove and edit files in
_slides/
to create presentation slides as needed. - Got to your GitHub pages site, all should be working.
This work is licensed under a Creative Commons Attribution 4.0 International License.
All content in this repository are licensed under the Creative Commons 4.0 - Attribution License or where applicable, as with software code, an Apache 2.0 Software License.
Contributions are welcome. You can contribute to this workshop by
- Submitting issues
- Forking the repository, editing it and submitting your proposed changes as a pull request.
Rob Olendorf