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

Commit

Permalink
resolve conflict
Browse files Browse the repository at this point in the history
  • Loading branch information
brianamarie committed May 8, 2019
2 parents 9d4776c + a9d17ad commit 2757e73
Show file tree
Hide file tree
Showing 14 changed files with 31 additions and 47 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,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.

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:

- Identify the structure of a Learning Lab course
- Define a title and description for your course
- Define a template repository
- Create course steps
- Create responses
- Publish a course to GitHub Learning Lab

> 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.
>
> 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).
12 changes: 6 additions & 6 deletions config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -414,7 +414,7 @@ steps:
```suggestion
- type: gate
```
position: 32
position: 27

# 12
- title: Validate a learner's pull request
Expand Down Expand Up @@ -445,7 +445,7 @@ steps:
```suggestion
left: '\%payload.pull_request.title\%'
```
position: 33
position: 28
- type: octokit
method: pullRequests.createComment
owner: '%payload.repository.owner.login%'
Expand All @@ -457,7 +457,7 @@ steps:
```suggestion
operator: ===
```
position: 34
position: 29
- type: octokit
method: pullRequests.createComment
owner: '%payload.repository.owner.login%'
Expand All @@ -469,7 +469,7 @@ steps:
```suggestion
right: Add name to README
```
position: 35
position: 30

# 13
- title: Use contextual information to validate
Expand Down Expand Up @@ -502,7 +502,7 @@ steps:
```suggestion
- type: respond
```
position: 36
position: 31
- type: octokit
method: pullRequests.createComment
owner: '%payload.repository.owner.login%'
Expand All @@ -514,7 +514,7 @@ steps:
```suggestion
with: pr-opened.md
```
position: 37
position: 32

# 14
- title: Respond to a learner's successful pull request
Expand Down
2 changes: 1 addition & 1 deletion responses/01.0_add-title.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
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).
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).

## Step 1: Name your course

Expand Down
4 changes: 0 additions & 4 deletions responses/01.1_e-branch.md

This file was deleted.

4 changes: 2 additions & 2 deletions responses/02.0_add-template.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
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.

### Template Repositories
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.
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.

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

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

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

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

<hr>
Expand Down
4 changes: 2 additions & 2 deletions responses/05.0_add-response.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ Great! Now, the repository will have an issue for the learner.

## Step 9: Creating a response

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

### :keyboard: Activity: Adding a response

1. In the `/responses/` folder, create a new file titled `welcome-text.md`
- 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 }})
- 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 }})
1. In that file, add some content that will appear to the learner in the welcome issue
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

Expand Down
6 changes: 3 additions & 3 deletions responses/06.0_add-first-step.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
Great! The learner's repository will now be setup with a single issue.

### Steps in Learning Lab
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.**
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.**

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.

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

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.

See [:book: best practices](https://lab.github.com/docs/3-5-responses#best-practices) in the Learning Lab docs for more suggestions.
See [:book: best practices](https://lab.github.com/docs/response-best-practices) in the Learning Lab docs for more suggestions.
</details>

## Step 9: Naming our first step

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

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

Expand Down
2 changes: 1 addition & 1 deletion responses/09.0_add-context.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
### Step 12: Add validation
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.
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.

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

Expand Down
4 changes: 2 additions & 2 deletions responses/11.0_add-descriptions.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
### Course metadata
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.
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.

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

## Step 2: Add course information

Expand Down
4 changes: 2 additions & 2 deletions responses/12.0_add-readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
### Course README
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.
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.

## Step 14: Add a README.md file

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

1. [Edit the `README.md` file]({{ fileUrl }}) to contain a description of the course
- 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**
- 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**

<hr>
<h3 align="center">I'll respond below when I detect a commit on this branch.</h3>
15 changes: 0 additions & 15 deletions responses/congratulations.md

This file was deleted.

1 change: 0 additions & 1 deletion responses/goto-transfer.md

This file was deleted.

14 changes: 10 additions & 4 deletions responses/how-to-publish.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
Since Learning Lab courses must be owned by your organization, you'll need to [fork](https://help.github.com/articles/fork-a-repo/) the course and template repositories there first. Here are the instructions:

## Publish the course
## Create the draft course
1. Choose an organization that will house your Learning Lab courses. You may have done this prior to taking the course.
1. Confirm that you are an owner of the chosen Learning Lab course organization, or a member of a team named **lab-assistants** in that organization.
1. [Fork this repository]({{ url }}) to your chosen organization.
1. [Add the template repository](https://github.com/githubtraining/lab-starter-template/fork) to your chosen organization.
1. Navigate to `{{ host }}/YOUR-ORGANIZATION/new`
1. In the Repository name field, type in **{{ repo }}**
1. We recommend selecting **Private** so you can test the course with other members of the organization before making it public.
1. Take the course, which should be available at {{ host }}/YOUR-ORGANIZATION/{{ repo }}.
1. In the Repository name field, type in **{{ repo }}**.
1. Take the draft course, which should be available at {{ host }}/YOUR-ORGANIZATION/{{ repo }}.

You can continue to [work on your course](https://lab.github.com/docs/testing#test-your-course) while it is in draft -- it will only be visible to you and other administrators of your repo.

## Publish the course

When you're ready to [publish your course](https://lab.github.com/docs/publishing), just go to your course's administration panel and click the button!

2 changes: 1 addition & 1 deletion responses/welcome-2.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### Documentation

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

### New to GitHub?

Expand Down

0 comments on commit 2757e73

Please sign in to comment.