[Teaching DevOps Wiki] [Issue Tracker]
Note: Guides and tutorials for working with lectures live in the Teaching DevOps Wiki. This README covers setup and the R package; for topics like slide authoring, compilation workflows, and CI troubleshooting, see the wiki.
This project has two goals:
- Provide common assets needed for all lectures, once, to keep them in sync.
- Check slides in lecture repositories (do they compile, are the PDFs up to date?).
(It also happens to be an R package lese you can install with many convenience functions)
For 1), all required files should live in ./service/ with the correct folder structure such that one can simply copy the files from this directory “on top” of an existing lecture, e.g.:
This is wrapped with the script in each lecture’s ./scripts/update-service.sh so within e.g. lecture_i2ml you can run
Any changes proposed to service files covered by ./service (particularly the style folder) will first need to be made in this repo and then dependent lecture repos can be updated accordingly.
Overview
The assumed directory structure once lecture repositories were cloned (or downloaded) looks like this:
lecture_service
├── lecture_advml
├── lecture_i2ml
├── lecture_sl
├── [...]
├── Makefile
├── R
├── scripts
├── service
└── [...]You can either manually git clone lecture repos or use make clone
Note that the text file include_lectures is used to globally keep track of the relevant lecture repos, so if you only intend to work on lecture_advml you could set it to only contain lecture_advml and subsequent make commands and other functions will be limited in scope to this lecture. By default it contains all lectures currently hosted at slds-lmu/.
Installation
The lese R package provides functions for compiling, checking, and auditing lecture slides.
# Install with pak (recommended)
pak::pak("slds-lmu/lecture_service")
# Or with remotes
remotes::install_github("slds-lmu/lecture_service")Alternatively, from within the lecture_service directory:
The package also includes a lecheck CLI tool; see the lecheck-cli wiki page for usage.