Expose course data over a (static) API (#1841)

illicitonion · web-flow · commit 01adb520ffde · 2026-04-23T16:24:45.000+01:00
This allows other systems to accurately model our courses.

There are currently no guarantees around stability of this API.
diff --git a/common-theme/layouts/_default/backlog.html b/common-theme/layouts/_default/backlog.html
@@ -1,4 +1,5 @@
 {{ define "main" }}
+  {{ $page := .Page }}
   {{ $currentPath := .Page.RelPermalink }}
   {{ $backlog_filter := .Page.Params.backlog_filter }}
   {{ $repos := .Page.Params.backlog }}
@@ -48,6 +49,7 @@
         {{ end }}
       {{ end }}
     {{ end }}
+    {{ $page.Scratch.Set "backlog-tasks" (dict "setup" $setupTasks "recurring" $recurringTasks "mandatory" $mandatoryTasks "optional" $optionalTasks) }}
     {{ if lt 0 ($setupTasks | len) }}
       <h2>Start Here</h2>
       <p>These tasks should be completed before attempting anything else.</p>
diff --git a/org-cyf/content/course_data/index.md b/org-cyf/content/course_data/index.md
@@ -0,0 +1,4 @@
++++
+layout = "course_data"
+outputs = ["json"]
++++
diff --git a/org-cyf/content/how-this-works/_index.md b/org-cyf/content/how-this-works/_index.md
@@ -2,6 +2,6 @@
 title = 'How this works'
 description = 'How we learn; how we organise; how we check our progress'
 layout = 'module'
-menu = ['ITP start here', "SDC start here"]
+menu = ['itp start here', "sdc start here"]
 weight=1
 +++
diff --git a/org-cyf/content/itp/_index.md b/org-cyf/content/itp/_index.md
@@ -1,7 +1,7 @@
 +++
 title="Intro to Programming"
-menus_to_map=["ITP start here", "ITP course schedule", "ITP next steps"]
-menu_prefix_to_strip = "ITP "
+menus_to_map=["itp start here", "itp course schedule", "itp next steps"]
+menu_prefix_to_strip = "itp "
 description="New? Lost? [Quickstart](how-this-works/prep/#overview)"
 layout="map"
 +++
diff --git a/org-cyf/content/itp/data-flows/_index.md b/org-cyf/content/itp/data-flows/_index.md
@@ -3,6 +3,6 @@ title = 'Data flows'
 description = 'Collaborate in code; Define and manage state; Use asynchronous programming to handle events and data; '
 layout = 'module'
 emoji= '🐥'
-menu = ['ITP course schedule']
+menu = ['itp course schedule']
 weight='5'
 +++
diff --git a/org-cyf/content/itp/data-groups/_index.md b/org-cyf/content/itp/data-groups/_index.md
@@ -3,6 +3,6 @@ title = 'Data groups'
 description = 'Organise and structure data; Build interactive user interfaces; Break problems down into sub-problems; Interpret acceptance criteria to form test cases'
 layout = 'module'
 emoji= '🐣'
-menu = ['ITP course schedule']
+menu = ['itp course schedule']
 weight='4'
 +++
diff --git a/org-cyf/content/itp/onboarding/_index.md b/org-cyf/content/itp/onboarding/_index.md
@@ -3,6 +3,6 @@ title = 'Onboarding'
 description = 'Evaluate and fix code with Lighthouse; use version control with Git and GitHub; Plan your study and set goals; Enroll as a Trainee'
 layout = 'module'
 emoji= '🫱🏾‍🫲🏿'
-menu = ['ITP course schedule']
+menu = ['itp course schedule']
 weight='2'
 +++
diff --git a/org-cyf/content/itp/overview/_index.md b/org-cyf/content/itp/overview/_index.md
@@ -1,8 +1,8 @@
 +++
 title="Course overview"
 layout="overview"
-overview_menu="ITP course schedule"
-menu=["ITP start here"]
+overview_menu="itp course schedule"
+menu=["itp start here"]
 description="4 modules of 3 sprints delivered over 12-16 weeks"
 weight=2
 emoji="🦉"
diff --git a/org-cyf/content/itp/structuring-data/_index.md b/org-cyf/content/itp/structuring-data/_index.md
@@ -3,6 +3,6 @@ title = 'Structuring and testing data'
 description = 'Find meaning behind syntax; Step through functions like a computer; Break problems down into sub-problems; Interpret acceptance criteria to form test cases; Recognise patterns'
 layout = 'module'
 emoji= '🥚'
-menu = ['ITP course schedule']
+menu = ['itp course schedule']
 weight='3'
 +++
diff --git a/org-cyf/content/itp/welcome/_index.md b/org-cyf/content/itp/welcome/_index.md
@@ -3,7 +3,7 @@ title = 'Welcome to Code Your Future'
 description = 'Our first day together '
 layout = 'module'
 emoji= '🫶🏽'
-menu = ['ITP course schedule']
+menu = ['itp course schedule']
 weight='1'
 parentsToTraverseToModule = 0
 moduleForRegister = "Welcome"
diff --git a/org-cyf/content/launch/_index.md b/org-cyf/content/launch/_index.md
@@ -4,6 +4,6 @@ description = "Work together in a cross functional Agile team to design, develop
 layout = "map"
 menus_to_map = ["Launch apply", "Launch develop", "Launch demo"]
 menu_prefix_to_strip = "Launch "
-menus = ["SDC next steps"]
+menus = ["sdc next steps"]
 weight = 9
 +++
diff --git a/org-cyf/content/piscine/_index.md b/org-cyf/content/piscine/_index.md
@@ -1,7 +1,7 @@
 +++
 title = 'Piscine'
 description = 'In teams and on your own, build working software with tests. Explain your work to others.'
-menu = ["ITP next steps"]
+menu = ["itp next steps"]
 menus_to_map=['Piscine entry', 'Piscine sprints', 'Piscine assessment']
 menu_prefix_to_strip = "Piscine "
 layout = 'map'
diff --git a/org-cyf/content/sdc/_index.md b/org-cyf/content/sdc/_index.md
@@ -1,7 +1,7 @@
 +++
 title = "Software Development Course"
-menus_to_map = ["SDC start here", "SDC", "SDC next steps"]
-menu_prefix_to_strip = "SDC "
+menus_to_map = ["sdc start here", "sdc course schedule", "sdc next steps"]
+menu_prefix_to_strip = "sdc "
 description = "Practical, employment-focused training in foundational software concepts."
 layout = "map"
 +++
diff --git a/org-cyf/content/sdc/complexity/_index.md b/org-cyf/content/sdc/complexity/_index.md
@@ -3,6 +3,6 @@ title = "Complexity"
 description = "Efficiency, optimisation, and trade-offs"
 layout = "module"
 emoji = "🪆"
-menu = ["syllabus", "core", "SDC"]
+menu = ["syllabus", "core", "sdc course schedule"]
 weight = "6"
 +++
diff --git a/org-cyf/content/sdc/decomposition/_index.md b/org-cyf/content/sdc/decomposition/_index.md
@@ -3,6 +3,6 @@ title = "Decomposition"
 description = "Breaking down problems into manageable chunks"
 layout = "module"
 emoji = "🧩"
-menu = ["syllabus", "core", "SDC"]
+menu = ["syllabus", "core", "sdc course schedule"]
 weight = "4"
 +++
diff --git a/org-cyf/content/sdc/legacy/_index.md b/org-cyf/content/sdc/legacy/_index.md
@@ -3,6 +3,6 @@ title = "Legacy code"
 description = "Working with code you didn't write: understanding, fixing, and extending legacy code"
 layout = "module"
 emoji = "🗺️"
-menu = ["syllabus", "SDC", "programming"]
+menu = ["syllabus", "sdc course schedule", "programming"]
 weight = "4"
 +++
diff --git a/org-cyf/content/sdc/logic/_index.md b/org-cyf/content/sdc/logic/_index.md
@@ -3,6 +3,6 @@ title = "Logic"
 description = "Thinking through problems systematically"
 layout = "module"
 emoji = "🚥"
-menu = ["syllabus", "core", "SDC"]
+menu = ["syllabus", "core", "sdc course schedule"]
 weight = "3"
 +++
diff --git a/org-cyf/content/sdc/overview/_index.md b/org-cyf/content/sdc/overview/_index.md
@@ -1,8 +1,8 @@
 +++
 title = "Course overview"
 layout = "overview"
-overview_menu = "SDC"
-menus = ["SDC start here"]
+overview_menu = "sdc course schedule"
+menus = ["sdc start here"]
 +++
 
 ## Objective
diff --git a/org-cyf/content/sdc/tools/_index.md b/org-cyf/content/sdc/tools/_index.md
@@ -3,6 +3,6 @@ title = "Tools"
 description = "How computers work; Using common tools and writing custom ones in multiple languages"
 layout = "module"
 emoji = "🧰"
-menu = ["syllabus", "core", "SDC"]
+menu = ["syllabus", "core", "sdc course schedule"]
 weight = "2"
 +++
diff --git a/org-cyf/layouts/_default/course_data.json b/org-cyf/layouts/_default/course_data.json
@@ -0,0 +1,51 @@
+{{- $site := .Site -}}
+
+{{- $courses := dict -}}
+
+{{- range $courseIndex, $course := (sort site.Data.courses "weight" "asc") -}}
+    {{- $modules := slice -}}
+    {{/* We only render courses where their course schedule menu is their course code followed by "course schedule".
+         Ideally this is a convention all courses should follow. If this is a problem, we could add an explicit menu name to the course data.
+         But for now, it's also a handy way of opting courses in-to/out-of listing in this API.
+    */}}
+    {{- $menuName := printf "%s course schedule" $course.code -}}
+    {{- if not (index $site.Menus $menuName) -}}
+        {{- continue -}}
+    {{- end -}}
+    {{- range $moduleIndex, $module := index $site.Menus $menuName -}}
+        {{- $sprints := slice -}}
+        {{- $maybePages := (append $module.Page $module.Page.Pages) -}}
+        {{- range $sprintIndex, $sprint := $maybePages -}}
+            {{/* Handle single-sprint modules which we detect with parentsToTraverseToModule=0 */}}
+            {{- if and (not (eq $sprint.Params.layout "sprint")) (not (eq $sprint.Params.parentsToTraverseToModule 0)) -}}
+                {{- continue -}}
+            {{- end -}}
+            {{- $backlogPage := "" -}}
+            {{- range $pageIndex, $page := $sprint.Pages -}}
+                {{- if eq $page.Params.layout "backlog" -}}
+                    {{- $backlogPage = $page -}}
+                {{- end -}}
+            {{- end -}}
+            {{- if eq $backlogPage "" -}}
+                {{- continue -}}
+            {{- end -}}
+            {{- $backlogTasks := slice -}}
+            {{- range $taskCategory, $tasks := $backlogPage.Scratch.Get "backlog-tasks" -}}
+                {{- range $taskIndex, $task := $tasks -}}
+                    {{- $submit := "" -}}
+                    {{- range $labelIndex, $label := $task.labels.nodes -}}
+                        {{ if hasPrefix $label.name "Submit:" -}}
+                            {{- $submit = strings.TrimPrefix "Submit:" $label.name -}}
+                        {{- end -}}
+                    {{- end -}}
+                    {{- $backlogTasks = append (dict "github_html_url" (index $task "src") "category" $taskCategory "submit" $submit "title" (index $task "name")) $backlogTasks -}}
+                {{- end -}}
+            {{- end -}}
+            {{- $sprints = append (dict "name" $sprint.Title "backlog_tasks" $backlogTasks) $sprints -}}
+        {{- end -}}
+        {{- $modules = append (dict "name" $module.Name "sprints" $sprints) $modules -}}
+    {{- end -}}
+    {{- $courses = merge $courses (dict $course.code (dict "name" $course.name "modules" $modules)) -}}
+{{- end -}}
+
+{{- jsonify (dict "courses" $courses) -}}

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 ++++
 +layout = "course_data"
 +outputs = ["json"]
 ++++