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

Commit 2757e73

Browse files
committed
resolve conflict
2 parents 9d4776c + a9d17ad commit 2757e73

14 files changed

+31
-47
lines changed

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
Learning Lab helps people build real world skills through hands-on activities. This course streamlines the course building process, and gives you all the tools you need to help others learn.
22

33
Register for this course to get the starter files needed to build your Learning Lab course, or complete the course steps for a fully guided experience. If you choose to complete the course, you'll be able to:
4+
45
- Identify the structure of a Learning Lab course
56
- Define a title and description for your course
67
- Define a template repository
78
- Create course steps
89
- Create responses
910
- Publish a course to GitHub Learning Lab
1011

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).

config.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -414,7 +414,7 @@ steps:
414414
```suggestion
415415
- type: gate
416416
```
417-
position: 32
417+
position: 27
418418

419419
# 12
420420
- title: Validate a learner's pull request
@@ -445,7 +445,7 @@ steps:
445445
```suggestion
446446
left: '\%payload.pull_request.title\%'
447447
```
448-
position: 33
448+
position: 28
449449
- type: octokit
450450
method: pullRequests.createComment
451451
owner: '%payload.repository.owner.login%'
@@ -457,7 +457,7 @@ steps:
457457
```suggestion
458458
operator: ===
459459
```
460-
position: 34
460+
position: 29
461461
- type: octokit
462462
method: pullRequests.createComment
463463
owner: '%payload.repository.owner.login%'
@@ -469,7 +469,7 @@ steps:
469469
```suggestion
470470
right: Add name to README
471471
```
472-
position: 35
472+
position: 30
473473

474474
# 13
475475
- title: Use contextual information to validate
@@ -502,7 +502,7 @@ steps:
502502
```suggestion
503503
- type: respond
504504
```
505-
position: 36
505+
position: 31
506506
- type: octokit
507507
method: pullRequests.createComment
508508
owner: '%payload.repository.owner.login%'
@@ -514,7 +514,7 @@ steps:
514514
```suggestion
515515
with: pr-opened.md
516516
```
517-
position: 37
517+
position: 32
518518

519519
# 14
520520
- title: Respond to a learner's successful pull request

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/01.1_e-branch.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

responses/02.0_add-template.md

Lines changed: 2 additions & 2 deletions
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

@@ -14,7 +14,7 @@ Let's add our own template repository. To speed things up, we've created a templ
1414

1515
### :keyboard: Activity: Add a template repository
1616

17-
1. Replace the commented `repo:` under `template:` in the `config.yml` file with a title of your first course
17+
1. Replace the commented `repo:` under `template:` in the `config.yml` file with a title of your template repository.
1818
- Note: You can do this by editing the file, or accepting my suggested change
1919

2020
<hr>

responses/05.0_add-response.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@ 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

99
1. In the `/responses/` folder, create a new file titled `welcome-text.md`
10-
- Note: If you're working on GitHub.com, you may need to navigate to the **Code** tab, checkout to the `add-metadata` branch, and click **Create new file**, or [use this shortcut]({{ fileUrl }})
10+
- Note: If you're working on GitHub.com, you may need to navigate to the **Code** tab, checkout to the `write-steps` branch, and click **Create new file**, or [use this shortcut]({{ fileUrl }})
1111
1. In that file, add some content that will appear to the learner in the welcome issue
1212
1. Add an instruction for the learner to open a new pull request titled "Add name to README" in which they add their name to the README file
1313

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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
### Course metadata
2-
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.
2+
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: 2 additions & 2 deletions
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

@@ -8,7 +8,7 @@ We added a README for you, but go ahead and put in your own content.
88
### :keyboard: Activity: Edit the README.md
99

1010
1. [Edit the `README.md` file]({{ fileUrl }}) to contain a description of the course
11-
- Note: If you're working on GitHub.com, you can click on the link above or navigate to the **Code** tab, checkout to the `add-metadata` branch, and click **Create new file**
11+
- Note: If you're working on GitHub.com, you can click on the link above or navigate to the **Code** tab, checkout to the `write-steps` branch, and click **Create new file**
1212

1313
<hr>
1414
<h3 align="center">I'll respond below when I detect a commit on this branch.</h3>

0 commit comments

Comments
 (0)