@@ -46,7 +46,7 @@ including links to the lines of source code on GitHub when possible:
4646There are two main components to any Learning Lab course for CodeQL that uses
4747the components in this repository:
4848
49- * ** Query Checking Action:**
49+ * [ ** Query Checking Action:** ] ( #creating-the-query-checking-action )
5050
5151 Each course has its own GitHub Action that is designed to be used in workflows
5252 that run when a course participant pushes new commits to their repo.
@@ -66,7 +66,7 @@ the components in this repository:
6666 and made available using
6767 [ GitHub Packages] ( https://github.com/features/packages ) .
6868
69- * ** Learning Lab Course:**
69+ * [ ** Learning Lab Course:** ] ( #creating-the-learning-lab-course )
7070
7171 This is the course itself.
7272 It creates the initial repository the participant will use for their course,
@@ -150,7 +150,7 @@ we recommend structuring your course folder like so:
150150
151151* (For your convinience,
152152we've created a template course that uses this file-structure
153- in the folder [ ` courses/template ` ] ( courses/template ) .
153+ in the folder [ ` templates/action ` ] ( templates/action ) .
154154You can simply copy the folder,
155155and follow the instructions in the template README for what things to replace).*
156156
@@ -264,6 +264,35 @@ ensure that:
264264 [`.github/workflows/publish.yml`](.github/workflows/publish.yml) to include
265265 testing and image publishing for your course.
266266
267+ # ## Creating the Learning Lab Course
268+
269+ If you have not created a Learning Lab course before,
270+ it is recommended to take the
271+ [course on creating a course](https://lab.github.com/githubtraining/write-a-learning-lab-course)!
272+
273+ There are core repositories that need to be created as part of any learning-lab
274+ course :
275+
276+ * **The course repository:**
277+ All the course configuration, instructions etc...
278+ * **The template repository:**
279+ The initial contents that populate the repository
280+ created on behalf of the course participant.
281+ (All courses are taken with respect to it's own repository)
282+
283+ We've created two template directories
284+ that you can use as a starting point for your own CodeQL Learning Lab Course :
285+
286+ * [`templates/learninglab/course`](templates/learninglab/course)
287+ * [`templates/learninglab/course-template`](templates/learninglab/course-template)
288+
289+ Simply copy the contents of these templates into their own repositories,
290+ and follow the [template instructions](templates/learninglab) to get started.
291+
292+ *(Remember that you need to create 2 separate repositories
293+ for your Learning Lab course,
294+ they can't be directories in an existing repo).*
295+
267296# # Example Courses
268297
269298* [GitHub Security Lab CTF 1: SEGV hunt](courses/cpp/ctf-segv)
0 commit comments