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

Commit fae0ac9

Browse files
committed
use new doc links
1 parent 77bf08c commit fae0ac9

File tree

8 files changed

+10
-10
lines changed

8 files changed

+10
-10
lines changed

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://lab.github.com/docs/3-4-yaml#set-up-the-course).
1+
In the next couple of steps we'll [:book: Set up the course](https://lab.github.com/docs/content-for-the-catalog#fields-used-for-the-catalog).
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://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.
4+
Most courses make use of a [:book: template repository](https://lab.github.com/docs/course-ownership-and-repositories#the-repositories). 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/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://lab.github.com/docs/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/writing-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://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.**
4+
Let's now dive into the `steps:`. This block is composed of [:book: steps](https://lab.github.com/docs/steps-block) that are triggered by [`events` on GitHub](https://lab.github.com/docs/events), and in turn certain [:book: `actions` take place](https://lab.github.com/docs/using-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://lab.github.com/docs/3-5-responses#best-practices) in the Learning Lab docs for more suggestions.
12+
See [:book: best practices](https://lab.github.com/docs/response-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://lab.github.com/docs/3-4-yaml#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/steps-block#options-for-steps) of how steps are shown to the learner.
1818

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

responses/09.0_add-context.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
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://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.
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/events#accessing-event-payloads) 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

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 now time to fill them in.
33

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.
4+
The [:book: course description and tagline](https://lab.github.com/docs/content-for-the-catalog#fields-used-for-the-catalog) 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

responses/12.0_add-readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
### Course README
2-
Our last step is to create a [:book: `README.md` file](https://lab.github.com/docs/2-3-course-repo#the-course-repository). This file will show on Learning Lab as users register. This file should contain learning outcomes and some long form content.
2+
Our last step is to create a [:book: `README.md` file](https://lab.github.com/docs/content-for-the-catalog#fields-used-for-the-catalog). This file will show on Learning Lab as users register. This file should contain learning outcomes and some long form content.
33

44
## Step 14: Add a README.md file
55

responses/welcome-2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Documentation
22

3-
:book: The official [Learning Lab docs](https://lab.github.com/docs/) contain full instructions on how to create courses. We'll link to the docs throughout the course. Take a look if you'd like more information about steps we take in this course.
3+
:book: The official [Learning Lab docs](https://lab.github.com/docs/writing-quickstart) contain full instructions on how to create courses. We'll link to the docs throughout the course. Take a look if you'd like more information about steps we take in this course.
44

55
### New to GitHub?
66

0 commit comments

Comments
 (0)