Skip to content
This repository was archived by the owner on Sep 1, 2022. It is now read-only.

Commit fa1877f

Browse files
authored
Merge pull request #26 from githubtraining/disclaimer
Prepare for public release
2 parents 12608ea + 18428db commit fa1877f

13 files changed

+20
-18
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,6 @@ Register for this course to get the starter files needed to build your Learning
88
- create responses
99
- publish a course to GitHub Learning Lab
1010

11-
**Note:** In order to publish your final course, you'll need to transfer it to your designated Learning Lab organization.
11+
> Note: Creating courses on Learning Lab is currently available in public beta. If you're not a member of the public beta, you will be unable to publish your course.
12+
>
13+
> Features and requirements may change at any time during this period. You can request to join the public beta by [contacting us](https://lab.github.com/organizations#form).

responses/01.0_add-title.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
In the next couple of steps we'll [:book: Set up the course](https://github.github.com/learning-lab-equipment/#/3-4-yaml?id=set-up-the-course).
1+
In the next couple of steps we'll [:book: Set up the course](https://lab.github.com/docs/3-4-yaml#set-up-the-course).
22

33
## Step 1: Name your course
44

responses/02.0_add-template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Great! The title will appear anywhere the course is referenced. We'll fill in some more of the course metadata later. First, let's get into its foundation.
22

33
### Template Repositories
4-
Most courses make use of a [:book: template repository](https://github.github.com/learning-lab-equipment/#/2-4-template). Template repositories are cloned for the learner and can contain starter code or resources to help them find their way.
4+
Most courses make use of a [:book: template repository](https://lab.github.com/docs/2-4-template). Template repositories are cloned for the learner and can contain starter code or resources to help them find their way.
55

66
When creating or choosing a template repository for your course, consider two main points.
77

responses/04.0_create-issue.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ Great! Now let's work on the `before:` block.
44
Anything in this block occurs before the learner can access their course repository.
55

66
### Learning Lab actions
7-
Actions are reusable modules that each course has access to. They are each designed to do very specific things, and nothing more. This is to optimize for reusability and simplicity. The documentation contains a listing of [:book: all available actions](https://github.github.com/learning-lab-equipment/#/actions/).
7+
Actions are reusable modules that each course has access to. They are each designed to do very specific things, and nothing more. This is to optimize for reusability and simplicity. The documentation contains a listing of [:book: all available actions](https://lab.github.com/docs/actions/).
88

99
## Step 7: Add to the `before` block
1010

11-
We'll use the [:book: `createIssue` action](https://github.github.com/learning-lab-equipment/#/actions/createIssue/) to create an issue for the learner with some initial instructions. The `createIssue` action requires two [:book: options](https://github.github.com/learning-lab-equipment/#/actions/createIssue/?id=options):
11+
We'll use the [:book: `createIssue` action](https://lab.github.com/docs/actions/createIssue/) to create an issue for the learner with some initial instructions. The `createIssue` action requires two [:book: options](https://lab.github.com/docs/actions/createIssue/#options):
1212
- a title
1313
- the body of the response
1414

responses/05.0_add-response.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Great! Now, the repository will have an issue for the learner.
22

33
## Step 9: Creating a response
44

5-
In the last step, we referenced a file titled `welcome-text.md`, but it doesn't exist. Learning Lab automatically looks in the [:book: `responses/` directory](https://github.github.com/learning-lab-equipment/#/3-5-responses) for all content files. Let's add it.
5+
In the last step, we referenced a file titled `welcome-text.md`, but it doesn't exist. Learning Lab automatically looks in the [:book: `responses/` directory](https://lab.github.com/docs/3-5-responses) for all content files. Let's add it.
66

77
### :keyboard: Activity: Adding a response
88

responses/06.0_add-first-step.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
Great! The learner's repository will now be setup with a single issue.
22

33
### Steps in Learning Lab
4-
Let's now dive into the `steps:`. This block is composed of [:book: steps](https://github.github.com/learning-lab-equipment/#/3-3-writing-steps) that are triggered by [`events` on GitHub](https://developer.github.com/v3/activity/events/types/), and in turn certain [:book: `actions` take place](https://github.github.com/learning-lab-equipment/#/actions/). **`actions` in this context are NOT the same as GitHub Actions.**
4+
Let's now dive into the `steps:`. This block is composed of [:book: steps](https://lab.github.com/docs/3-3-writing-steps) that are triggered by [`events` on GitHub](https://developer.github.com/v3/activity/events/types/), and in turn certain [:book: `actions` take place](https://lab.github.com/docs/actions/). **`actions` in this context are NOT the same as GitHub Actions.**
55

66
Each step maps directly to something that the user will do. User interaction on GitHub triggers the step, and Learning Lab responds. The user interaction could be creating a pull request, closing an issue, or editing a file. When designing a course, it's important to plan for the user interactions to reflect what you want them to learn.
77

88
<details><summary>Best practices for steps</summary>
99

1010
For example, you _could_ write a lot of text and have the user close the issue when they're done. But, unless your text was telling them how to close an issue, that reaction doesn't make sense. Try to find a way to have the user demonstrate their knowledge, like by committing a function to a branch. Let the user _show_ they understand to trigger the next step.
1111

12-
See [:book: best practices](https://github.github.com/learning-lab-equipment/#/3-5-responses?id=best-practices) in the Learning Lab docs for more suggestions.
12+
See [:book: best practices](https://lab.github.com/docs/3-5-responses#best-practices) in the Learning Lab docs for more suggestions.
1313
</details>
1414

1515
## Step 9: Naming our first step
1616

17-
Let's name our first step. We will give it a **title** and a **description**. These will be shown on Learning Lab, and they help course authors stay organized in the `config.yml` file. The docs show [:book: syntax and examples](https://github.github.com/learning-lab-equipment/#/3-4-yaml?id=relevant-syntax-1) of how steps are shown to the learner.
17+
Let's name our first step. We will give it a **title** and a **description**. These will be shown on Learning Lab, and they help course authors stay organized in the `config.yml` file. The docs show [:book: syntax and examples](https://lab.github.com/docs/3-4-yaml#relevant-syntax-1) of how steps are shown to the learner.
1818

1919
### :keyboard: Activity: Naming our first step
2020

responses/08.0_validate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The events that can act as triggers help Learning Lab know when something happens. However, sometimes knowing it happened isn't enough. For example, if we ask a learner to commit a function to a file, we'll get a trigger that they've committed to a branch. But we would receive the same trigger, even if they committed to a different file!
44

5-
Course authors can use **gates** to be validate the user's completion of a step. A [:book: `gate`](https://github.github.com/learning-lab-equipment/#/actions/gate/) is a Learning Lab action. Gates are conditionals, and they behave much like a conditional in Javascript. Let's add a `gate`, we'll specify its options in a later step.
5+
Course authors can use **gates** to be validate the user's completion of a step. A [:book: `gate`](https://lab.github.com/docs/actions/gate/) is a Learning Lab action. Gates are conditionals, and they behave much like a conditional in Javascript. Let's add a `gate`, we'll specify its options in a later step.
66

77
## Step 11: Add a gate
88

responses/09.0_add-context.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
### Step 12: Add validation
2-
We need to validate against the learner's pull request title. This information is accessible to us [:book: from the payload](https://github.github.com/learning-lab-equipment/#/3-3-writing-steps?id=accessing-payload-data) that is sent with the event. In this case, the information was sent from a `pull_request.opened` event.
2+
We need to validate against the learner's pull request title. This information is accessible to us [:book: from the payload](https://lab.github.com/docs/3-3-writing-steps#accessing-payload-data) that is sent with the event. In this case, the information was sent from a `pull_request.opened` event.
33

44
You can see an example of all the information sent [in the GitHub Developer docs](https://developer.github.com/v3/activity/events/types/#webhook-payload-example-26).
55

6-
We'll add the [:book: `left:` option](https://github.github.com/learning-lab-equipment/#/actions/gate/?id=options) to the gate, and compare its value to the expected pull request's title.
6+
We'll add the [:book: `left:` option](https://lab.github.com/docs/actions/gate/#options) to the gate, and compare its value to the expected pull request's title.
77

88
A completed example of this would look as follows, with comments on the right starting with a hash `#`:
99
```yaml

responses/10.0_respond-success.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Let's respond to the learner by commenting in their pull request. We'll let them
66

77
### :keyboard: Activity: Responding to successful actions
88

9-
1. In the same step, add a [:book: `respond` action](https://github.github.com/learning-lab-equipment/#/actions/respond/)
9+
1. In the same step, add a [:book: `respond` action](https://lab.github.com/docs/actions/respond/)
1010
1. Add a `with: pr-opened.md` option for the response file
1111

1212
You can also accept the suggested changes below. You don't need to worry about the `pr-opened.md` file, since [we created it]({{ fileUrl }}) for you, but feel free to change its contents.

responses/11.0_add-descriptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
### Course metadata
22
Remember your course's metadata, near the top of your config? We left the description and tagline empty at the start of this course, but it's not time to fill them in.
33

4-
The [:book: course description and tagline](https://github.github.com/learning-lab-equipment/#/3-4-yaml?id=relevant-syntax) will be included on the Learning Lab site. Users will see this information before they sign up for the course.
4+
The [:book: course description and tagline](https://lab.github.com/docs/3-4-yaml#relevant-syntax) will be included on the Learning Lab site. Users will see this information before they sign up for the course.
55

66
## Step 2: Add course information
77

0 commit comments

Comments
 (0)