From 0c4af84481b6ed279c9daaf488c0b055fc12eceb Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Mon, 24 Feb 2025 16:12:52 +0100 Subject: [PATCH] updates --- book/exercises/001.md | 1 + book/exercises/007.md | 20 ++++++++++++++------ book/exercises/009.md | 36 ++++++++++++++++++++++++++++++++++-- book/exercises/summary.md | 11 ++++++++--- book/exercises/type3.md | 10 +++++++++- book/exercises/type4.md | 5 ++++- 6 files changed, 70 insertions(+), 13 deletions(-) diff --git a/book/exercises/001.md b/book/exercises/001.md index af92980..5e56d75 100644 --- a/book/exercises/001.md +++ b/book/exercises/001.md @@ -1,3 +1,4 @@ +(exercise_1)= # 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. diff --git a/book/exercises/007.md b/book/exercises/007.md index 8c575d4..4257764 100644 --- a/book/exercises/007.md +++ b/book/exercises/007.md @@ -1,16 +1,24 @@ -# Exercise 6: Add your first content (File Structure) +# Exercise 6: File Structure (Markdown) -Now that you've made your own version of the book, it's time to add some content. +In this exercise you will add the structure to your chapters. + +```{tip} + +More useful Markdown syntax is explained in the [MyST cheat sheet](https://jupyterbook.org/en/stable/reference/cheatsheet.html). + +``` 1. Navigate to the file you want to work in (for example `book/some_content/overview.md`) and make sure you're in the correct branch. 2. Let's create the structure of your chapter. You can start by adding a title to the section. The title is always defined in the first line of the file after the hashtag `#`. Then yo can also add sections and subsections as needed. ``` -# Chapter Title (H1) -## Section Title (H2) -### Subsection Title (H3) -#### Smaller Heading (H4) +# Chapter Title +## Section Title +### Subsection Title +#### Smaller Heading +##### Heading level 5 +###### Heading level 6 ``` 3. Add some text to the sections. diff --git a/book/exercises/009.md b/book/exercises/009.md index 36da758..a49a9c9 100644 --- a/book/exercises/009.md +++ b/book/exercises/009.md @@ -1,2 +1,34 @@ -# Ninth exercises -kdjb \ No newline at end of file +# Exercise 9: Referencing using target headers + +It can be really useful to refer to a specific section in your book while working in a different file. Referencing can be done using target headers. ()= + +1. Navigate to the file you want to work in (for example `book/some_content/overview.md`) and make sure you're in the correct branch. + +2. Identify the section you want to reference and name it ebtween bracketsfor example exercise_1. + +``` +(exercise_1)= +# 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... + +``` + +3. Referncing + +There are three types of referencing + +If you want to refernce in line you can use: + +My favourte exercise was {ref}`exercise_1`. + +``` +My favourte exercise was {ref}`exercise_1`. +``` +You can specify the text of the target: + +{ref}`MyST syntax lecture <exercise_1>` + +Another alternative is to use Markdown syntax: + +[MyST syntax lecture](exercise_1) \ No newline at end of file diff --git a/book/exercises/summary.md b/book/exercises/summary.md index 866137e..25bc7d6 100644 --- a/book/exercises/summary.md +++ b/book/exercises/summary.md @@ -1,6 +1,6 @@ # Summary of exercises: All Exercises -With the exercises, you did all the steps of our TeachBooks workflow! +With the simple exercises, you did all the steps of our TeachBooks workflow! ```{figure} https://github.com/TeachBooks/logos_and_visualisations/blob/main/TB_flowchart/TeachBooks_flowchart.svg?raw=true --- @@ -9,7 +9,7 @@ align: center --- ``` -Here is how the exercises relate to the workflow. +Here is how these exercises relate to the workflow. | Step No. | Name | Exercise | Description | | :---: | :---: | :---: | :---: | @@ -18,4 +18,9 @@ Here is how the exercises relate to the workflow. | 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 +| 6 | Submit for review | 5, 6 | Open and merge a Pull Request, from a branch or forks | + +## Keep practicing + +For additional practice, there are more exercises relating to the capacities of each user type. +Have a look in the [manual](https://teachbooks.io/manual/installation-and-setup/user_types.html) to see which user type you are! \ No newline at end of file diff --git a/book/exercises/type3.md b/book/exercises/type3.md index 0c64beb..7c67e14 100644 --- a/book/exercises/type3.md +++ b/book/exercises/type3.md @@ -1 +1,9 @@ -# User Type 3 \ No newline at end of file +# User Type 3 + +Now that you've made your own version of the book, it's time to add some content. As user type 3 you will work primarily in `.md` (Markdown) or `.ipynb`(Jupyter Notebook) files. In Jupyter Book, `.md` files contain text-based content with formatting, while ipynb` files contain both text and executable code cells. In this exercise you will learn how to structure a `.md` file. + +Exercises for user type 3 relate to: + +- File Structure (Markdown) +- In-text referencing +- Adding a figure \ No newline at end of file diff --git a/book/exercises/type4.md b/book/exercises/type4.md index 51b1490..59eaaa7 100644 --- a/book/exercises/type4.md +++ b/book/exercises/type4.md @@ -1 +1,4 @@ -# User type 4 \ No newline at end of file +# User type 4 + + +User 4 is a hybrid between type 3 and 5. Basically this user is making changes by editing the .md files locally using, for example, VS Code. Therefore, this user requires a little bit more knowledge on git (think of pulling and pushing changes) but their main focus remains to make adjustments to the content of the book by editing .md files whereas user type 5 has more knowledge to make changes to python files the book as well. This user can build the book online and therefore does not need to have special software installed besides a text editor (e.g., Python is not required). Using this skills, this user type can take the role as editor, managing more than just book content. \ No newline at end of file