Add 'cp' (Carpentry) as a new lesson type
authorFrançois Michonneau <francois.michonneau@gmail.com>
Fri, 15 Jun 2018 15:55:22 +0000 (11:55 -0400)
committerMaxim Belkin <maxim.belkin@gmail.com>
Fri, 15 Jun 2018 15:55:22 +0000 (15:55 +0000)
* Add 'cp' (Carpentry) as a lesson type (for instructor training)
* Explain lesson type abbreviations (swc, dc, lc, cp)
* Emphasize the fact that there is no need to edit "repository" variable in front matter

bin/boilerplate/_config.yml
bin/lesson_check.py

index dbc08da8f3a77fe1f95997650281b1bbd4619e1d..8409420b3c2ee86c84b986d03a27b816df49a0b9 100644 (file)
@@ -2,7 +2,11 @@
 # Values for this lesson.
 #------------------------------------------------------------
 
-# Which carpentry is this ("swc", "dc", or "lc")?
+# Which carpentry is this ("swc", "dc", "lc", or "cp")?
+# swc: Software Carpentry
+# dc: Data Carpentry
+# lc: Library Carpentry
+# cp: Carpentries (to use for instructor traning for instance)
 carpentry: "swc"
 
 # Overall title for pages.
@@ -20,6 +24,7 @@ kind: "lesson"
 
 # Magic to make URLs resolve both locally and on GitHub.
 # See https://help.github.com/articles/repository-metadata-on-github-pages/.
+# Please don't change it: <USERNAME>/<PROJECT> is correct.
 repository: <USERNAME>/<PROJECT>
 
 # Sites.
index 93a10d9b2e958560ef70a734622e93cdc2eb849e..8ed1bf89f594a8db28f1dc76ae5d7c3eab06c9f6 100755 (executable)
@@ -171,7 +171,7 @@ def check_config(reporter, source_dir):
     reporter.check_field(config_file, 'configuration',
                          config, 'kind', 'lesson')
     reporter.check_field(config_file, 'configuration',
-                         config, 'carpentry', ('swc', 'dc', 'lc'))
+                         config, 'carpentry', ('swc', 'dc', 'lc', 'cp'))
     reporter.check_field(config_file, 'configuration', config, 'title')
     reporter.check_field(config_file, 'configuration', config, 'email')