Include more structure and start with bullet points

mittler-works · mittler-works · commit bd3365329c32 · 2025-06-30T15:22:20.000+02:00
diff --git a/learning-pathways/jupyter-based-teaching.md b/learning-pathways/jupyter-based-teaching.md
@@ -13,26 +13,38 @@ funding:
 tags: [jupyter, teaching]
 
 pathway:
-  - section: "Part One: Introduction"
-    description: Advantages and limitations of Jupyter-based teaching
+  - section: "Learn the basics about Jupyter-based teaching"
+    description: "Advantages and limitations of Jupyter-based teaching"
     tutorials:
       - topic: teaching
         name: jbt-intro
 
-  - section: "Part Two: Customization"
-    description: Tweak jupyter to your specific needs
+  - section: "Customize Jupyter to your needs"
+    description: "Adapt Jupyter to your course or workshop specific needs"
     tutorials:
       - topic: teaching
         name: jbt-customization-1
       - topic: teaching
         name: jbt-customization-2
 
-  - section: "Part Three: Featured customizations"
-    description: Battle-tested and recommended customizations for teaching 
+  - section: "Featured customizations"
+    description: "Battle-tested and recommended Jupyter extensions for teaching "
     tutorials:
       - topic: teaching
         name: jbt-featured
 
+  - section: "For teachers: Use custom Jupyter Images with JHaaS"
+    description: "Learn how to teach a course or workshop with your Jupyter customizations on JHaaS"
+    tutorials:
+      - topic: teaching
+        name: jbt-jhaas
+
+  - section: "For admins: Provide your Jupyter Images with Galaxy"
+    description: "Learn how to provide your custom Jupyter customizations on your Galaxy instance"
+    tutorials:
+      - topic: teaching
+        name: jbt-galaxy
+
 ---
 
-You'll learn about the advantages of using jupyter for teaching and how you can adapt jupyter to the very specific needs of your course or workshop.
+You'll learn about the advantages of using Jupyter for teaching and how you can adapt Jupyter to the very specific needs of your course or workshop. As a teacher, you'll learn how to teach a course or workshop using your Jupyter customizations. As a Galaxy admin, you'll learn how to provide your users with a customized Jupyter.
diff --git a/topics/teaching/tutorials/jbt-customization-1/tutorial.md b/topics/teaching/tutorials/jbt-customization-1/tutorial.md
@@ -1,20 +1,70 @@
 ---
 layout: tutorial_hands_on
 
-title: An introduction to jupyter customization
+title: Basics of Jupyter customization
 subtopic: practises
 draft: true
 time_estimation: 1h
 questions:
-  - How can I make basic customizations to jupyter?
+  - How can I make basic customizations to Jupyter?
 objectives:
-  - An introduction is provided on how to make basic jupyter customizations, e.g. installing additional plugins.
+  - An introduction is provided on how to make basic Jupyter customizations, e.g. installing additional plugins.
 key_points:
   - Basic customization costs litte effort and makes it easier for your course participants to get started.
 contributors:
   - mittler-works
 ---
 
-# Introduction
+# Prerequisites
 
-(WIP)
+* We'll use containerized installation
+
+* Examples with docker, as it is easy to install on all major platforms
+
+# Start your first local Notebook Server with docker
+
+* Show docker stacks
+
+* Select an image
+
+* WIP
+
+## Access your local Notebook Server
+
+* Windows and Mac users will need verification work...
+
+* WIP
+
+## Missing packages
+
+* Install a simple python package
+
+* WIP
+
+# Docker Compose (?)
+
+* Maybe introduce compose to reduce complexity of terminal interaction
+
+# Build your first custom Image
+
+* WIP
+
+# Use your first custom Image
+
+* WIP
+
+## Access your local custom Notebook Server
+
+* WIP
+
+## See your custom changes
+
+* WIP
+
+# Extend your custom Image
+
+* Install a simple plugin like `igv-notebook`
+
+* WIP
+
+# (WIP)
diff --git a/topics/teaching/tutorials/jbt-customization-2/tutorial.md b/topics/teaching/tutorials/jbt-customization-2/tutorial.md
@@ -1,14 +1,14 @@
 ---
 layout: tutorial_hands_on
 
-title: Advanced jupyter customization
+title: Advanced Jupyter customization
 subtopic: practises
 draft: true
 time_estimation: 1h
 questions:
-  - How can I do more with jupyter?
+  - How can I tailor Jupyter to my specific teaching needs?
 objectives:
-  - A guide to advanced jupyter customization is provided, e.g. how to install proxy applications.
+  - A guide to advanced Jupyter customization is provided, e.g. how to install proxy applications.
 key_points:
   - Advanced customitzations may be time-consuming, but offer great potential and reusability value.
 contributors:
@@ -17,4 +17,46 @@ contributors:
 
 # Introduction
 
-(WIP)
+Now we know how to include changes, we will build something more complex and look at some pitfalls.
+
+# Install an additional Kernel
+
+* e.g. rust kernel, or R
+
+* WIP
+
+# Config Changes
+
+* Where to put them
+
+* What to put there
+
+* WIP
+
+# Persistent Data
+
+* HomeDir will be overlayed with a mounted Volume
+
+* WIP
+
+## External persistent Data
+
+* WIP
+
+## Large Data
+
+* Don't include it into your Image!
+
+* WIP
+
+## Sensitive Data (?)
+
+* Maybe WIP, but maybe put that into `jbt-intro`
+
+# Application Proxies
+
+* E.G. installing `code-server`
+
+# (WIP)
+
+* WIP
diff --git a/topics/teaching/tutorials/jbt-featured/tutorial.md b/topics/teaching/tutorials/jbt-featured/tutorial.md
@@ -1,7 +1,7 @@
 ---
 layout: tutorial_hands_on
 
-title: Featured jupyter customizations
+title: Featured Jupyter customizations
 subtopic: practises
 draft: true
 time_estimation: 1h
@@ -17,4 +17,30 @@ contributors:
 
 # Introduction
 
+We present adaptions that the JLU Physics Department has been successfully using in its courses for over a year and consider to be a great addition to the default Jupyter notebook server.
+
+# nbgitpuller
+
+## Install
+
+## Configuration
+
+## Usage
+
+# nbgrader
+
+## Install
+
+## Configuration
+
+## Usage
+
+# Config customizations
+
+## Dos and Don'ts
+
+# Setup Scripts
+
+## Where to place them what to do with them
+
 (WIP)
diff --git a/topics/teaching/tutorials/jbt-galaxy/tutorial.bib b/topics/teaching/tutorials/jbt-galaxy/tutorial.bib
diff --git a/topics/teaching/tutorials/jbt-galaxy/tutorial.md b/topics/teaching/tutorials/jbt-galaxy/tutorial.md
@@ -0,0 +1,24 @@
+---
+layout: tutorial_hands_on
+
+title: Provide your custom Jupyter Image via Galaxy
+subtopic: practises
+draft: true
+time_estimation: 1h
+questions:
+  - As a Galaxy admin, how can I provide my users with a custom Notebook Server?
+objectives:
+  - Learn how to add additional interactive tools for each Jupyter customization.
+key_points:
+  - Each user-base has different needs. It's easy to serve them providing customized Jupyter Notebook Servers.
+contributors:
+  - mittler-works
+---
+
+# Introduction
+
+(WIP)
+
+# Create a new interactive tool definition (xml)
+
+# Include your new interactive tool definition into your galaxy installation
diff --git a/topics/teaching/tutorials/jbt-intro/tutorial.md b/topics/teaching/tutorials/jbt-intro/tutorial.md
@@ -1,20 +1,48 @@
 ---
 layout: tutorial_hands_on
 
-title: An introduction to jupyter based teaching
+title: An introduction to Jupyter based teaching
 subtopic: practises
 draft: true
-time_estimation: 1h
+time_estimation: 30m
 questions:
-  - What are the general advantages and limitations of jupyter based teaching?
+  - What are the general advantages and limitations of Jupyter based teaching?
 objectives:
-  - An overview is provided to familiarize teachers with the advantages and limitations of jupyter-based teaching.
+  - An overview is provided to familiarize teachers with the advantages and limitations of Jupyter-based teaching.
 key_points:
   - Jupyter-based teaching offers an easy entrypoint for students, but deprives them of the need to learn basic setup steps themselves.
 contributors:
   - mittler-works
 ---
 
-# Introduction
+# Glossary
 
-(WIP)
+* Jupyter
+
+* Jupyter Notebook
+
+* Jupyter Notebook Server
+
+* JupyterLab
+
+* JupyterHub
+
+# Advantages for teaching
+
+* Predefined Environment
+
+* Web-based
+
+* BYD
+
+* Reproducability
+
+# Disadvantages for teaching
+
+* Important first steps are not need to be taught
+
+* Habituation effects
+
+* Jail effects
+
+# (WIP)
diff --git a/topics/teaching/tutorials/jbt-jhaas/tutorial.bib b/topics/teaching/tutorials/jbt-jhaas/tutorial.bib
diff --git a/topics/teaching/tutorials/jbt-jhaas/tutorial.md b/topics/teaching/tutorials/jbt-jhaas/tutorial.md
@@ -0,0 +1,40 @@
+---
+layout: tutorial_hands_on
+
+title: Teaching a course with custom Jupyter via JHaaS
+subtopic: practises
+draft: true
+time_estimation: 1h
+questions:
+  - How can I use my Jupyter customizations in a course relevant matter?
+objectives:
+  - Learn how to teach a course via JHaaS using your Jupyter customizations.
+key_points:
+  - Don't worry about infrastructure and service deployment, use JHaaS.
+contributors:
+  - mittler-works
+---
+
+# Getting Started with JHaaS
+
+## Authenticate
+
+## Apply for Teacher role
+
+# Make your customizations available
+
+* e.g. docker hub
+
+# Create a new JupyterHub Request
+
+## Use your custom image
+
+# Manage your participants
+
+## Invitations
+
+## Applications
+
+# Teach your course
+
+(WIP)
