search

partyshah / lab-starter

https://lab.github.com/githubtraining/write-a-learning-lab-course
0 stars 0 forks source link

Setup the learner's repo #3

Closed github-learning-lab[bot] closed 5 years ago

github-learning-lab[bot] commented 5 years ago

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

First, how will this content help teach the concept? For example, if a course is teaching HTML, the success of the finished product should feature HTML.

Second, is the finished product useful? At the end of the course, the finished repository should serve a purpose aside from the lessons. A working game, a portfolio or resume, or a collection of template documents are a few examples.

Step 4: Designate a template repository

Let's add our own template repository. To speed things up, we've created a template repository for you. We recommend using our template for this course.

:keyboard: Activity: Add a template repository

  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

I'll respond below when I detect a commit on this branch.

github-learning-lab[bot] commented 5 years ago

Awesome! Whenever a user registers for this course, Learning Lab will create a new repository for them based on lab-starter-template.

Step 5: Name the repository

lab-starter-template is a great template repository, and it's named to reflect that. But, we want the user to experience that repository through a different name. We can designate that name in the config.yml.

:keyboard: Activity: Update the repository name

  1. Change the field name: as part of the template: section to anything you like
    • Note: You can do this by editing the file, or accepting my suggested change

I'll respond below when I detect a commit on this branch.

github-learning-lab[bot] commented 5 years ago

Step 6: Submit your approval

We've now identified the template repository and given the learner's repo a name. Let's merge it in.

:keyboard: Activity: Approve the template repo information

  1. Approve this pull request.

I'll respond below when I detect an approval on this pull request.

github-learning-lab[bot] commented 5 years ago

Let's go to the next PR.