Skip to content

Commit

Permalink
Added exercises separately
Browse files Browse the repository at this point in the history
  • Loading branch information
Tom-van-Woudenberg committed Dec 13, 2024
1 parent 8a676ba commit 3ed48d0
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 19 deletions.
3 changes: 3 additions & 0 deletions book/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ parts:
- file: some_content/overview.md
sections:
- file: some_content/text_and_code.ipynb
- file: exercises/exercises
sections:
- file: exercises/001.md
- file: references.md
- file: changelog.md
- file: credits.md
25 changes: 25 additions & 0 deletions book/exercises/001.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Exercise 1: First file edit

Let's start with the most basic edit: add some text to a file and see that the website is updated. This exercise is ready for you at https://teachbooks.io/template/exercises/001

Can you add some content to the intro page? Let's start with just some text!

1. Go to the source file of this page on your GitHub repository (`https://github.com/<your_username>/<your_repo_name>`) - {octicon}`code;1em` `Code` - `Book` - `intro.md` - {octicon}`pencil;1em` `Edit this file`
2. Add some text. You want to be create already, have a look at the [MyST cheat sheet](https://jupyterbook.org/en/stable/reference/cheatsheet.html)
3. Click `Commit changes`
4. Add a description of your change
5. Select `Commit directly to the main branch` (this adds your change your change to the default version instead of making a new one)
6. Click `Commit changes`
7. Go to {octicon}`play;1em` `Actions` - The most recent workflow run `Update intro.md / the name of the commit you just made` - Wait for it to finish - In the summary, click on the link of your book shown in the table `Branches deployed` and under `Primary book at root`
8. Do you see your change? If you don't see it click `CTRL`+`F5`/`Control`+`F5`to refresh the page (your browser keeps a cached version of website you recently visit, but we actually want the most up-to-date version!).

```{admonition} Check your understanding
:class: tip
Before moving on to the next exercise, make sure you understand the following:
1. Where are the contents of the book stored?
2. How can you edit a single file via the GitHub browser interface?
3. What is a commit and what role does it play in the editing process?
4. Given a specific GitHub repository, can you determine the URL of the book website?
5. Where is the book metadata stored?
```
3 changes: 3 additions & 0 deletions book/exercises/exercises.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Exercises

Want to get started making books? Follow these exercises!
17 changes: 1 addition & 16 deletions book/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,4 @@

_This is the first page the student will see when opening the url._

This book can be used as a template for other books. It includes a starter package of the software developed by the TeachBooks initiative and some exercises to get you going!

```{admonition} Exercise 1: Edit contents
:class: tip
Can you add some content to this page? Let's start with just some text!
1. Go to the source file of this page on your GitHub repository (`https://github.com/<your_username>/<your_repo_name>`) - {octicon}`code;1em` `Code` - `Book` - `intro.md` - {octicon}`pencil;1em` `Edit this file`
2. Add some text. You want to be create already, have a look at the [MyST cheat sheet](https://jupyterbook.org/en/stable/reference/cheatsheet.html)
3. Click `Commit changes`
4. Add a description of your change
5. Select `Commit directly to the main branch` (this adds your change your change to the default version instead of making a new one)
6. Click `Commit changes`
7. Go to {octicon}`play;1em` `Actions` - The most recent workflow run `Update intro.md / the name of the commit you just made` - Wait for it to finish - In the summary, click on the link of your book shown in the table `Branches deployed` and under `Primary book at root`
8. Do you see your change? If you don't see it click `CTRL`+`F5`/`Control`+`F5`to refresh the page (your browser keeps a cached version of website you recently visit, but we actually want the most up-to-date version!).
```
This book can be used as a template for other books. It includes a starter package of the software developed by the TeachBooks initiative and some exercises to get you going!
3 changes: 0 additions & 3 deletions book/some_content/exercises.md

This file was deleted.

0 comments on commit 3ed48d0

Please sign in to comment.