Skip to content

activities.md

Latest commit

 

History

History
44 lines (31 loc) · 1.71 KB

activities.md

File metadata and controls

44 lines (31 loc) · 1.71 KB

git4ol Activities

At it's core a learning experience can be thought of as a guided set of activities a student takes to eventually get certified on a defined topic.

In git4ol we translate that experience to git commits and refs and the same way that git commits are the main building blocks of a git repository activities are the main building blocks of a git4ol lesson.

Assets

Activity assets are located in directories according to this naming scheme:

  • Step assets are located in directories of the format refs/{lesson}@{version}/step/{n} where

    • lesson is the name of the lesson
    • version is a valid semver
    • n is a positive number indicating the step number

  • Challenge assets are located in directories of the format refs/{lesson}@{version}/challenge/{challenge} where

    • lesson is the name of the lesson
    • version is a valid semver
    • challenge is the name of the challenge

Title and instructions

Activity title and instructions serialized in the same way as Jekyll content.

---
id:
title: Our first markdown file
notes:
type: ide
files:
  - README.md
---

[Markdown](http://daringfireball.net/projects/markdown/) is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format

Let's start by adding a `README.md` file with some mock content.

Some of the front matter properties are reserved for git4ol:

  • id - sha1 (internal) : The activity ID based on the git commit
  • title - string (required) : The activity title
  • notes - markdown (optional) : The activity notes