Merge pull request #16 from github/learninglab-course

Add instructions for creating Learning Lab Course

Author: Sam Lanning

.github/workflows/ci.yml

@@ -40,12 +40,12 @@ jobs:
       run: docker login docker.pkg.github.com -u github-actions -p ${{ secrets.GITHUB_TOKEN }}
 
     - name: Build Images & Run Queries
-      run: cd courses/template && ../../scripts/test-course-actual.sh
+      run: cd templates/action && ../../scripts/test-course-actual.sh
   test-courses-template-latest:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
       uses: actions/checkout@v1
 
     - name: Build Images & Run Queries
-      run: cd courses/template && ../../scripts/test-course-latest.sh
+      run: cd templates/action && ../../scripts/test-course-latest.sh

README.md

@@ -29,11 +29,12 @@ including links to the lines of source code on GitHub when possible:
 **Table of Contents**
 
 - [Creating your own course](#creating-your-own-course)
-  - [Creating the GitHub Action](#creating-the-github-action)
+  - [Creating the Query Checking Action](#creating-the-query-checking-action)
     - [Testing the action](#testing-the-action)
     - [Adding new queries & calculating the contents for the CSV files](#adding-new-queries--calculating-the-contents-for-the-csv-files)
     - [Publishing your action](#publishing-your-action)
   - [Contributing your GitHub Action to this repository](#contributing-your-github-action-to-this-repository)
+  - [Creating the Learning Lab Course](#creating-the-learning-lab-course)
 - [Example Courses](#example-courses)
 - [Contributing](#contributing)
   - [Releasing new versions or updating dependencies](#releasing-new-versions-or-updating-dependencies)
@@ -46,7 +47,7 @@ including links to the lines of source code on GitHub when possible:
 There are two main components to any Learning Lab course for CodeQL that uses
 the components in this repository:
 
-* **Query Checking Action:**
+* [**Query Checking Action:**](#creating-the-query-checking-action)
 
   Each course has its own GitHub Action that is designed to be used in workflows
   that run when a course participant pushes new commits to their repo.
@@ -66,7 +67,7 @@ the components in this repository:
   and made available using
   [GitHub Packages](https://github.com/features/packages).
 
-* **Learning Lab Course:**
+* [**Learning Lab Course:**](#creating-the-learning-lab-course)
 
   This is the course itself.
   It creates the initial repository the participant will use for their course,
@@ -75,7 +76,7 @@ the components in this repository:
   has completed the current task correctly,
   and is ready to advance to the next one.
 
-### Creating the GitHub Action
+### Creating the Query Checking Action
 
 *(for an example of a working action,
 see [`courses/cpp/ctf-segv`](courses/cpp/ctf-segv)).*
@@ -150,7 +151,7 @@ we recommend structuring your course folder like so:
 
 *(For your convinience,
 we've created a template course that uses this file-structure
-in the folder [`courses/template`](courses/template).
+in the folder [`templates/action`](templates/action).
 You can simply copy the folder,
 and follow the instructions in the template README for what things to replace).*
 
@@ -264,6 +265,35 @@ ensure that:
   [`.github/workflows/publish.yml`](.github/workflows/publish.yml) to include
   testing and image publishing for your course.
 
+### Creating the Learning Lab Course
+
+If you have not created a Learning Lab course before,
+it is recommended to take the
+[course on creating a course](https://lab.github.com/githubtraining/write-a-learning-lab-course)!
+
+There are core repositories that need to be created as part of any learning-lab
+course:
+
+* **The course repository:**
+  All the course configuration, instructions etc...
+* **The template repository:**
+  The initial contents that populate the repository
+  created on behalf of the course participant.
+  (All courses are taken with respect to it's own repository)
+
+We've created two template directories
+that you can use as a starting point for your own CodeQL Learning Lab Course:
+
+* [`templates/learninglab/course`](templates/learninglab/course)
+* [`templates/learninglab/course-template`](templates/learninglab/course-template)
+
+Simply copy the contents of these templates into their own repositories,
+and follow the [template instructions](templates/learninglab) to get started.
+
+*(Remember that you need to create 2 separate repositories
+for your Learning Lab course,
+they can't be directories in an existing repo).*
+
 ## Example Courses
 
 * [GitHub Security Lab CTF 1: SEGV hunt](courses/cpp/ctf-segv)