-
-
Notifications
You must be signed in to change notification settings - Fork 16
/
config.yaml
85 lines (67 loc) · 2.09 KB
/
config.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
#------------------------------------------------------------
# Values for this lesson.
#------------------------------------------------------------
# Which carpentry is this (swc, dc, lc, or cp)?
# swc: Software Carpentry
# dc: Data Carpentry
# lc: Library Carpentry
# cp: Carpentries (to use for instructor training for instance)
# incubator: The Carpentries Incubator
#
# This option supports custom types so lessons can be branded
# and themed with your own logo and alt-text (see `carpentry_description`)
# See https://carpentries.github.io/sandpaper-docs/editing.html#adding-a-custom-logo
carpentry: 'incubator'
# Alt-text description of the lesson.
carpentry_description: 'Lesson Description'
# Overall title for pages.
title: 'Lesson Title' # FIXME
# Date the lesson was created (YYYY-MM-DD, this is empty by default)
created: ~ # FIXME
# Comma-separated list of keywords for the lesson
keywords: 'software, data, lesson, The Carpentries' # FIXME
# Life cycle stage of the lesson
# possible values: pre-alpha, alpha, beta, stable
life_cycle: 'pre-alpha' # FIXME
# License of the lesson
license: 'CC-BY 4.0'
# Link to the source repository for this lesson
source: 'https://github.com/carpentries/workbench-template-md' # FIXME
# Default branch of your lesson
branch: 'main'
# Who to contact if there are any issues
contact: '[email protected]' # FIXME
# Navigation ------------------------------------------------
#
# Use the following menu items to specify the order of
# individual pages in each dropdown section. Leave blank to
# include all pages in the folder.
#
# Example -------------
#
# episodes:
# - introduction.md
# - first-steps.md
#
# learners:
# - setup.md
#
# instructors:
# - instructor-notes.md
#
# profiles:
# - one-learner.md
# - another-learner.md
# Order of episodes in your lesson
episodes:
- introduction.md
# Information for Learners
learners:
# Information for Instructors
instructors:
# Learner Profiles
profiles:
# Customisation ---------------------------------------------
#
# This space below is where custom yaml items (e.g. pinning
# sandpaper and varnish versions) should live