From 08fd386338a9ffe590e3face43dd5db170cb215a Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Thu, 19 Dec 2024 09:22:45 +0100 Subject: [PATCH] Moved over exercises properly --- book/_toc.yml | 1 + book/exercises/exercises.md | 18 +- book/exercises/summary.md | 21 + book/figures/TeachBooks_flowchart.svg | 1006 +++++++++++++++++++++++++ 4 files changed, 1045 insertions(+), 1 deletion(-) create mode 100644 book/exercises/summary.md create mode 100644 book/figures/TeachBooks_flowchart.svg diff --git a/book/_toc.yml b/book/_toc.yml index 10f519a..b03fc0c 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -15,6 +15,7 @@ parts: - file: exercises/004.md - file: exercises/005.md - file: exercises/006.md + - file: exercises/summary - file: references.md - file: changelog.md - file: credits.md diff --git a/book/exercises/exercises.md b/book/exercises/exercises.md index 7603399..4dfee99 100644 --- a/book/exercises/exercises.md +++ b/book/exercises/exercises.md @@ -1,3 +1,19 @@ # Exercises -Want to get started making books? Follow these exercises! \ No newline at end of file +Getting used to the syntax of writing in a Jupyter Book can be a bit daunting at the start, not to mention becoming familiar with the various tools and workflows required. To help make the learning curve somewhat easier to travel, a number of exercises have been prepared for you as part. The exercises are designed such that no prior experience with any tools or programming is required, as long as you have read the preceding introductory pages. + +```{exercise} +Work through the exercises attached to this page (you can find them in the left sidebar). +``` + +```{tip} +Maybe you're already comfortable with Git, GitHub and the concept of using software to parse text-based files and create marked-up documents. In that case, can you answer the following questions (referring to the exercises): +1. Can you add some content to the intro page? +2. Can you add the file named `file_to_be_added_to_toc.md` to the book website? +3. Can you edit the repository url defined in the `_config.yml`, change the title shown below the logo and change the author as shown in the footer? +4. Can you make a new branch of your book with an additional file `file_on_new_version.md` and view it online? +5. Can you merge your branch into `main` with a pull request? +6. Can you fork someone else's repo, and suggest a change in a pull request? + +If something is not clear, dive into to the relevant exercise page. +``` diff --git a/book/exercises/summary.md b/book/exercises/summary.md new file mode 100644 index 0000000..ad71194 --- /dev/null +++ b/book/exercises/summary.md @@ -0,0 +1,21 @@ +# Summary of Workshop: All Exercises + +With the exercises, you did all the steps of our TeachBooks workflow! + +```{figure} ../figures/TeachBooks_flowchart.svg +--- +width: 500px +align: center +--- +``` + +Here is how the exercises relate to the workflow. + +| Step No. | Name | Exercise | Description | +| :---: | :---: | :---: | :---: | +| 1 | Get and idea | 4 | Create an issue | +| 2 | Create _your_ version of the book | 4 | Create a branch | +| 3 | Edit the book | 1, 2, 3| Editing `.md`-files, the `_toc.yml` and the `_config.yml` | +| 4 | Check changes online | 1, 2, 3 | Workflows and Actions Summary | +| 5 | Repeat edit and checking | 1, 2, 3, 4, 5 | Keep on doing all the steps until it's ready| +| 6 | Submit for review | 5, 6 | Open and merge a Pull Request, from a branch or forks | \ No newline at end of file diff --git a/book/figures/TeachBooks_flowchart.svg b/book/figures/TeachBooks_flowchart.svg new file mode 100644 index 0000000..0ed6f33 --- /dev/null +++ b/book/figures/TeachBooks_flowchart.svg @@ -0,0 +1,1006 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file