Skip to content

Commit

Permalink
add one more video
Browse files Browse the repository at this point in the history
  • Loading branch information
firasm committed Sep 28, 2023
1 parent 328140e commit 97ff261
Show file tree
Hide file tree
Showing 32 changed files with 43 additions and 29 deletions.
3 changes: 2 additions & 1 deletion _toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ parts:
chapters:
- file: content/pl/intro
- file: content/pl/intro_structure
- file: content/instructors/irene_intro
- file: content/pl/irene_intro
- file: content/pl/teaching_with_pl

- caption: 2. Instructor Guide
chapters:
Expand Down
1 change: 0 additions & 1 deletion content/dev/videos.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

Coming soon...


<!--
- [Next Generation Problem Bank](https://vimeo.com/559780900)
- [Introduction to Prairie Learn](https://vimeo.com/554493760)
Expand Down
4 changes: 2 additions & 2 deletions content/pl/intro.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
(prairielearn_intro)=
# Introduction to PrairieLearn
(teaching_with_pl)=
# Teaching with PrairieLearn

Here's a quick tour of some question types on PrairieLearn:

Expand Down
50 changes: 25 additions & 25 deletions content/instructors/irene_intro.md → content/pl/irene_intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,40 +7,40 @@ The following guide was written by Dr. Irene Vrbik as she was given a tour of th
Questions from the Open Problem Bank (OPB) will be hosted on PrairieLearn (PL): https://ca.prairielearn.com/pl (requires sign in).
There is a course _OPB 000_ which contains all the questions from all the banks that have been created - so far, Physics, Data Science, and Statistics.

![](instructors_images/irene_intro/prairie-learn-course-list.png)
![](irene_intro/prairie-learn-course-list.png)

### Courses

Every course in Prairie Learn is associated with a GitHub repository, usually `pl-ubc-course_code`.
For example, the fake course above is associated with: https://github.com/PrairieLearnUBC/pl-ubc-opb000.
Every "instance" of a course is stored in a different directory of the GitHub repo:

![](instructors_images/irene_intro/courseinstances.png)
![](irene_intro/courseinstances.png)

### Instances

An "instance" usually correspond to a particular offering of a course.
When you click on instance on PL, you will give you all the homework that you set for that particular offering of the course (you can copy these from previous years).

![](instructors_images/irene_intro/pl-course-instance.png)
![](irene_intro/pl-course-instance.png)

### Questions

Every _assessment_ has to have a corresponding _category_:

![](instructors_images/irene_intro/category-assessment.png)
![](irene_intro/category-assessment.png)

If you click an assessment, it will default to the questions tab, which lists all of the questions in that assessment:

![](instructors_images/irene_intro/assessment-questions.png)
![](irene_intro/assessment-questions.png)

### Files

In the `Files` tab, you will see a JSON file which sets what questions are in each assessment.
Every question you create will have weights that will add up to 1.
You can scale how much a question is worth on a assessment with the `points` option:

![](instructors_images/irene_intro/json.png)
![](irene_intro/json.png)

For example, the `Motion_of_watermelon` question will be worth 2.5 and the `merry_go_round` question will only be worth 1.5.
If the watermelon question was five parts with equal weight for each part, each part would be award 0.5 points each.
Expand All @@ -53,35 +53,35 @@ Note that you can not yet point to a directory and have to list every question y

### Question Stats

![](instructors_images/irene_intro/question-stats.png)
![](irene_intro/question-stats.png)
On the `Question stats` tab in PL, you can see view some question analytics:
![](instructors_images/irene_intro/analytics.png)
![](irene_intro/analytics.png)

This could be useful in configuring which questions should be grouped together (e.g. makes sense for _swimming mass_ and _speed skating_ to be grouped together since they have similar stats) and if the difficulty level is appropriate.

### Access Rules

![](instructors_images/irene_intro/PLaccess.png)
![](irene_intro/PLaccess.png)

Block 1 indicates when the student will be able to see the assessment (`active: false` indicates that they won't be able to click it).
Block 2 indicates when the student will be able to see AND access the assessment.
The `credit` level indicates how much credit they will receive if they complete the assessment during the associated window.
You can also do more complicated `credit` levels to penalize late submissions.

![](instructors_images/irene_intro/late-penalty.png)
![](irene_intro/late-penalty.png)

In addition you could provide some incentive for completing the assessment early.
This can be a great way to catch mistakes before the bulk of the students start their first attempt

![](instructors_images/irene_intro/early-reward.png)
![](irene_intro/early-reward.png)

> Question: can you create penalties for additional attempts?
## GitHub repo

On the [github repo](https://github.com/PrairieLearnUBC/pl-ubc-opb000) you will see a folder entitled `questions` we will store all of the questions that we will be eventually putting in to our prairie learn Stats course (not yet created).

![](instructors_images/irene_intro/github-questions.png)
![](irene_intro/github-questions.png)

This is the backhand structure (which is optional^[its not clear to my how this is optional]). Inside each of the disciple directory there will be sub directories of topics. Inside each topic, is a subtopic. For example the `physics` folder contains the topic sub directories of `001.Math`, ... , `003.Vectors`, ..., `008.Energy`, ... e.g., `008.Energy` topic has subtopics of Conservation of Energy, Energy Diagrams, Kinetic Energy, Pendulum Kinetics, etc.

Expand All @@ -92,7 +92,7 @@ This is the backhand structure (which is optional^[its not clear to my how this
Each questions will be stored in one of this subtopic sub-sub-directories.
There is a minimum of three files associated with every question.

![](instructors_images/irene_intro/question-folder.png)
![](irene_intro/question-folder.png)

- `info.json` contains the meta data (e.g., title, tags, topic)
- `question.html` what the student sees
Expand All @@ -101,17 +101,17 @@ There is a minimum of three files associated with every question.
### Prairie Learn Search

To see the corresponding question in Prairie learn, navigate to the questions tab:
![](instructors_images/irene_intro/prairie-questions.png)
![](irene_intro/prairie-questions.png)

Unfortunately, the folder system isn't visible to the use in the Finder-like way, and it shows all the questions in the `questions` directory as a long list.
So to find the particular question used as example in [Github file view] you would look up the question name _Kinetic Energy Definition_ in the Prairie Learn search bar:
![](instructors_images/irene_intro/prairie-search.png)
![](irene_intro/prairie-search.png)

When you click on the question (make sure you are in the Preview mode) you will be able to see how the student will view the question (which is rendered from the `question.html` file):
![](instructors_images/irene_intro/prairie-student-view.png)
![](irene_intro/prairie-student-view.png)

You can view the source files by pressing the Files tab
![](instructors_images/irene_intro/prairie-file-path.png)
![](irene_intro/prairie-file-path.png)

The path to the question in PL (highlighted in green above) is the same as the path in the corresponding github subdirectory in the `questions` folder: https://github.com/PrairieLearnUBC/pl-ubc-opb000/tree/master/questions/physics/008.Energy/Kinetic%20Energy/Kinetic%20Energy%20Definition.
These three files are created from the ... source file; the process is explained in [Mark down system].
Expand All @@ -120,14 +120,14 @@ These three files are created from the ... source file; the process is explained

The `server.py` file is where the random numbers and options are generated. Custom grading can also go here.

![](instructors_images/irene_intro/server-py.png)
![](irene_intro/server-py.png)

### question.html

This file generates the question that the student will view on PL.
Within the `question.html` file, you can pull anything from the `server.py` file (_via_ curly brackets `{{ }}`)

![](instructors_images/irene_intro/question-html.png)
![](irene_intro/question-html.png)

### Mark down system

Expand All @@ -139,25 +139,25 @@ The way we have set it up, we will not be editing the questions in PL, nor the c
Instead we will be reviewing questions in a separate GitHub repo: https://github.com/open-resources/instructor_stats_bank.
Here we will be reviewing the markdown files (as described in [Mark down system], these md files get converted to the 3 files we need for a PL question).

![](instructors_images/irene_intro/github-pull-request.png)
![](irene_intro/github-pull-request.png)

![](instructors_images/irene_intro/awaiting-review.png)
![](irene_intro/awaiting-review.png)

To start your review, click the `Add your review` at the top of the page:

![](instructors_images/irene_intro/add-your-review.png)
![](irene_intro/add-your-review.png)

Once you click that button, you will be shown all the files that are being changed in that pull request.
If you want to make a comment about a particular line(s)^[Multiline comments can be made but clicking and dragging] of code, click the "+" sign and leave a comment:
![](instructors_images/irene_intro/comment.png)
![](irene_intro/comment.png)

Even if you are not asked to do a review, you can still click on a question and select the `Files Changed`:

![](instructors_images/irene_intro/sample-question.png)
![](irene_intro/sample-question.png)

At the top of the md file, you will see the title of the question

![](instructors_images/irene_intro/question-title.png)
![](irene_intro/question-title.png)

Assuming this question has already been moved to PL, you can search for this question name as described in [PrairieLearn Search].

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
14 changes: 14 additions & 0 deletions content/pl/teaching_with_pl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
(prairielearn_intro)=
# Introduction to PrairieLearn

Here's a quick tour of some question types on PrairieLearn:

```{dropdown} Teaching with PrairieLearn
:class-container: sd-shadow-lg
:color: primary
:open:
<div class="container youtube">
<iframe class="responsive-iframe" src="https://player.vimeo.com/video/860392528?h=3d70825fa0&amp;badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" frameborder="0" allow="autoplay; fullscreen; picture-in-picture" style="position:absolute;top:0;left:0;width:100%;height:100%;" title="2023-08-30 - Teaching with PrairieLearn"></iframe><script src="https://player.vimeo.com/api/player.js"></script>
</div>
```

0 comments on commit 97ff261

Please sign in to comment.