search

ps185367 / lab-starter

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

Import the course #4

Open github-learning-lab[bot] opened 3 years ago

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

Import your course

Woohoo! You could keep going - but now your course can actually be tested. Let's talk about that.

Importing your course into Learning Lab

When you're ready to start testing your course, you'll need to import it into Learning Lab. Here are a few things you'll need to know.

Create and test draft courses

When you create a new course on Learning Lab, the course will be a draft. While in draft, you can test your course by going to the course dashboard, and clicking on View course page next to the course title.

You can continue to work on your course while it is in draft. It will only be visible to you and other administrators of your repository.

Step 14: Import the course

:keyboard: Activity: Import this repository as a course on GitHub Learning Lab

  1. Navigate to https://lab.github.com/ps185367/new.
  2. In the Repository name field, type in lab-starter.
  3. Click Create course.
  4. Take the draft course, which should be available at https://lab.github.com/ps185367/lab-starter.
  5. Once you are done, comment in this issue.

If you need help troubleshooting, scroll down for some tips!

I'll respond below when I detect a comment in this issue.

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

Troubleshooting: Importing a course

If you're having trouble importing your course, here are a few tips for troubleshooting.

I can't find the place to import

There are a few different ways to create a course:

Since we used the manual method in this course, follow the instructions in the "Create the course on Learning Lab (manual option" paragraph.

This should lead you to a URL that looks like https://lab.github.com/:owner/new. (Ex: https://lab.github.com/githubtraining/new)

My import fails and I don't know why

Validate the YAML

Try to validate the YAML in the config.yml using a tool like yamllint.

Check response files

Check the responses referenced in the the config.yml file. Do they all exist? Are they in a directory called responses? Are there any typos?

Get more detailed error messages

More detailed error messages are available for draft courses made from pull requests. To do this, the course must first be published. Create another branch with the most up-to-date version of your course. Edit the course version on the main branch to reduce the possibility for errors. (You can do this by matching the boilerplate repository.)

Actions for every event

If you have events or steps listed in your config.yml, they need to have at least one action. Make sure that every step has correlating actions.

Still stuck

If you're still stuck, visit us in the Community Forum and we'll be happy to help!

ps185367 commented 3 years ago

Done

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

Try out your course

Go ahead and take the course! You'll be able to register for the course, and take it. What do you think?

Step 15: Close the issue

:keyboard: Activity: To signal that you've tested your course, close this issue

  1. Once you're able to go through the course, close this issue.

I'll respond below when I detect this issue is closed.