Lesson Title

This lesson shows how to use the Software Carpentry and Data Carpentry lesson template. For guidelines on how to help improve our lessons and this template, please see the contribution guidelines; for guidelines on how to set up your machine to preview changes locally, please see the setup instructions.

Prerequisites

Use the .prereq style to specify prerequisites.

Ten Things You Need To Know

  1. Don’t panic.
  2. Create a new lesson by using GitHub Import, not by forking.
  3. Run bin/lesson_initialize.py once in a new lesson repository to set up standard files.
  4. Run make lesson-check to check that the lesson is formatted correctly.
  5. Put lesson episodes in _episodes (or _episodes_rmd if you are writing in RMarkdown).
  6. Run make serve to preview the lesson website locally.
  7. Do not commit the generated HTML files in the _site directory.
  8. Style blocks and code samples by putting {: .stylename} on a newline after the block or code.
  9. Put solutions inside challenges using nested blockquotes.
  10. File issues and template fixes in the styles repository, and enhancements to this documentation in this one.

Schedule

Setup Download files required for the lesson
00:00 1. Lesson Design How do we design lessons?
00:10 2. GitHub, Markdown, and Jekyll How are pages published?
00:20 3. Lesson Organization How are the files in a lesson organized?
00:30 4. Formatting How are Software and Data Carpentry lessons formatted?
00:40 5. Using RMarkdown How to write a lesson using RMarkdown?
00:52 6. Style Guide How are keyboard key combinations written?
01:02 7. Checking and Previewing How can lesson formatting be checked?
How can lessons be previewed?
01:07 8. Maintenance What do lesson maintainers do?
01:12 9. Coffee Break Break
01:27 Finish

The actual schedule may vary slightly depending on the topics and exercises chosen by the instructor.