Introduction

Overview

Teaching: 0 min
Exercises: 0 min

Questions

• How do we edit this documentation?

Objectives

• Understand how to create and configure additional documentation repositories.

These instructions are adapted from the Software Carpentry tooling guide.

1. To start, we import (don’t clone!) the Software Carpentry styles repository using the GitHub Importer.
   • for this project, we imported into graveslab/howto.
2. Clone the new repo locally, e.g. with git clone git@github.com:/graveslab/howto bc-lab-howto
3. cd into the repo directory and run bin/lesson_initialize.py once to generate an initial Jekyll configuration file (_config.yml) and some other files.
4. edit _config.yml to customize it for your project.
5. start creating lesson material in _episodes and _extras!

Key Points

• This documentation site was derived from templates prepared by Software Carpentry.

• This site is built by jekyll, a static site generator, and served using GitHub Pages.