Skip to content

Commit

Permalink
feat: include Binder with preset notebook & warning about notes.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rzmk committed May 31, 2024
1 parent 67587d6 commit 4b85757
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 12 deletions.
2 changes: 1 addition & 1 deletion _toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ chapters:
title: Getting started
sections:
- file: lessons/0/notes
title: Exploring qsv help messages and syntax
title: "Lesson 0: Exploring qsv help messages and syntax"
- file: appendix
23 changes: 19 additions & 4 deletions exercises-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

At the end of each lesson there may be an exercise that you may complete either:

- Within the page (uses Thebe) [](#thebe)
- In-browser (uses Thebe) [](#thebe)
- In an online Jupyter lab environment (uses myBinder) [](#binder)
- Locally on your computer [](#local)

You may choose an approach you prefer then [continue to the next page](getting-started.md).
Expand All @@ -19,11 +20,21 @@ Here's a screen recording that shows how to do this for each lesson:

![Thebe demo](media/thebe-demo.gif)

<!-- (exercises-setup:binder)=
[➡ Continue to the next page.](getting-started.md)

(exercises-setup:binder)=

### Binder

In the header for a lesson click the rocket icon and then in the dropdown click `Binder`. Binder should be launching and once ready (may take a few seconds/minutes) an online Jupyter lab environment is set up for you to work with. -->
Each exercise should have a launch button for launching an online Jupyter lab environment using myBinder **(this may take a few seconds/minutes)**. You may choose to launch an exercise by clicking the following button when it appears in a lesson:

![Binder](https://mybinder.org/badge_logo.svg)

:::{warning}
When a Jupyter lab environment is ready, you may find a `notes.md` file in your lab's files. We recommend you **ignore the `notes.md` file** as this file is the same one used to render the lesson page which may contain the solution to the exercise.
:::

[➡ Continue to the next page.](getting-started.md)

(exercises-setup:local)=

Expand All @@ -36,7 +47,11 @@ You may choose to run the exercises on your system. The rest of this page is an
1. [Click here to download the `100.dathere.com.zip` file](https://github.com/dathere/100.dathere.com/archive/refs/heads/main.zip).
2. Unzip `100.dathere.com.zip`. You may delete everything except the `lessons` folder.

As you follow along with a lesson page on `100.dathere.com`, once an exercise appears then you may change directory into the relevant folder (e.g., `cd lessons/0` for the first exercise). We recommend you ignore the `notes.md` file in each lesson folder as the lesson is rendered as intended on `100.dathere.com` and the file may also contain the solution to the exercise.
As you follow along with a lesson page on `100.dathere.com`, once an exercise appears then you may change directory into the relevant folder (e.g., `cd lessons/0` for the first exercise).

:::{warning}
We recommend you **ignore the `notes.md` file in each lesson folder** as this file is the same one used to render the lesson page at `100.dathere.com` which may contain the solution to the exercise.
:::

#### 2. Set up qsv

Expand Down
2 changes: 1 addition & 1 deletion getting-started.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Getting started

This section includes introductory lessons including concepts found commonly in qsv and command-line usage. If you're new to qsv or want to follow the exercises in order, continue on to the first lesson.
This section includes introductory lessons and exercises about concepts found commonly in qsv and command-line usage. If you're new to qsv or want to follow the exercises in order, continue on to the first lesson.
4 changes: 2 additions & 2 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ qsv pro (preview) is a **cross-platform desktop app** for spreadsheet data wrang
Each lesson usually follows this outline:

- Lesson content
- Exercise instructions (may also include instructions on how to verify your solution)
- Solution (optional hints, try the exercise first before viewing any hints though)
- Exercise instructions
- Solution

You don't need to follow all the lessons in order nor do you need to complete all of them. Feel free to skip around to lessons you find intriguing.

Expand Down
10 changes: 8 additions & 2 deletions lessons/0/exercise.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,20 @@
{
"cell_type": "markdown",
"metadata": {},
"source": ["# Exercise 0: Total rows"]
"source": [
"# Exercise 0: Total rows\n",
"\n",
"Using a qsv command, get the total number of rows that are in the `fruits.csv` file."
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": []
"source": [
"qsv --list"
]
}
],
"metadata": {
Expand Down
6 changes: 4 additions & 2 deletions lessons/0/notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ kernelspec:
name: bash
---

# Getting help
# Lesson 0: Exploring qsv help messages and syntax

## Listing all commands

Expand Down Expand Up @@ -68,9 +68,11 @@ Now it's your turn to take on the first exercise.

## Exercise 0: Total rows

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/dathere/100.dathere.com/main?labpath=lessons%2F0%2Fexercise.ipynb)

Using a qsv command, get the total number of rows that are in the `fruits.csv` file.

> Here we list qsv commands for your reference. Solve this exercise using [Thebe](exercises-setup:thebe) or [locally](exercises-setup:local).
> Here we list qsv commands for your reference. Solve this exercise using [Thebe](exercises-setup:thebe), [Binder](exercises-setup:binder) or [locally](exercises-setup:local).
```{code-cell}
:tags: ["scroll-output"]
Expand Down

0 comments on commit 4b85757

Please sign in to comment.