Apprentice

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.

1. A home page with prequisites and objectives
2. Online tutorial composed of units
3. A slide deck for presentations
4. Instructors notes

Useage

Quick Start

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.

1. Fork the repository
2. Edit _config.yml as described in the comments
3. Edit _data/objectives.yml and _data/prereqs.yml to outline course objectives and prequisites.
4. Create, remove and edit files in _units/ to create course units. _units/overview.md is documented with guidance.
5. Create, remove and edit files in _slides/ to create presentation slides as needed.
6. Got to your GitHub pages site, all should be working.

Licensing

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.

Contributing

Contributions are welcome. You can contribute to this workshop by

1. Submitting issues
2. Forking the repository, editing it and submitting your proposed changes as a pull request.

Contributors

Rob Olendorf