From 41b8e9d8c37738a94c5d4a9e1a1bec2d446bbe08 Mon Sep 17 00:00:00 2001 From: Christoph Fink Date: Tue, 21 Feb 2023 14:05:51 +0200 Subject: [PATCH 1/3] add better instructions for future teachers to readme --- README.md | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index a450d471d..4469dfd8f 100644 --- a/README.md +++ b/README.md @@ -108,15 +108,27 @@ few days to get everything set up. [Follow the instructions in the `Automating-GIS-processes/csc-notebook-dockerfile` repository](https://github.com/Automating-GIS-processes/csc-notebook-dockerfile) -4. Set up Slack TODO - -5. Set up GitHub classroom TODO (make new org, create per-exercise repository) +4. Set up Slack: Create a new Slack instance, e.g., + ‘Automating-GIS-processes-2023’, and set up the channel structure such as in + previous years: `#general` and `#random` exist by default, create `#week1` + through `#week7`, as well as `#final-assignments`; create `#instructors` to + coordinate with the student tutors. *I (@christophfink) will leave the 2022 + version around, drop me a line and I’ll add you there so you can see for what + we used Slack*. + +5. Set up GitHub classroom: register for GitHub Education + (https://classroom.github.com), create a new organisation for this year’s + exercise repository templates (see + [Automating-GIS-processes-2022](https://github.com/Automating-GIS-processes-2022), + and add the exercise repositories there, one by one, as the course advances. + For each exercise, create a classroom, and update the links in the respective + `docs/lesson-X/exercise-X.md` files. 6. Update the course details defined in [`conf.py`](docs/conf.py). Things that -change every year are set up as ‘substitutions’, variables that are replaced -throughout all documents. Edit them to reflect this year’s course’s details -(as of October 2022, this block is starting [at line 42 of -`conf.py`](docs/conf.py#L42)): + change every year are set up as ‘substitutions’, variables that are replaced + throughout all documents. Edit them to reflect this year’s course’s details + (as of October 2022, this block is starting [at line 42 of + `conf.py`](docs/conf.py#L42)): ``` # The following are the main things that need to be updated every year @@ -133,13 +145,6 @@ throughout all documents. Edit them to reflect this year’s course’s details