admin2/template
1
0
Fork 0
mirror of https://github.com/TeachBooks/template.git synced 2026-11-12 22:25:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Made it TU Delft specific

Browse source
This commit is contained in:
Tom van Woudenberg 2025-01-13 17:35:47 +01:00
parent 060cd74e6a
commit 1da4cf05c4
16 changed files with 50 additions and 183 deletions
Download patch file Download diff file Expand all files Collapse all files

4
book/exercises/001.md
View file

@ -1,10 +1,12 @@
# Exercise 1: First file edit
> This page reuses CC BY 4.0 licensed content from {cite:t}`template`. {fa}`quote-left`{ref}`Find out more here.<external_resources>`
Let's start with the most basic edit: add some text to a file and see that the website is updated.
> Can you add some content to the intro page?
1. Go to the the file `book/intro.md` 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`
1. Go to the the file `book/intro.md` on your GitHub repository (`https://github.com/<your_username>/<your_repo_name>` or `https://github.com/TUDelft-books/<your_repo_name>`) - {octicon}`code;1em` `Code` - `Book` - `intro.md` - {octicon}`pencil;1em` `Edit this file`
2. Add some text. Feeling brave? Have a look at the [MyST cheat sheet](https://jupyterbook.org/en/stable/reference/cheatsheet.html). Don't worry if that feels daunting, there will be exercises on this!
3. Click `Commit changes`
4. Add a message and description of your change. With this `commit` you save your changes to the git-timeline. Any commit can always be reverted. Therefore, it's useful to shortly explain what is included in your commit. Later on, you'll make commits which may contain changes to many different files. In that case, a descriptive commit message and description is even more useful!

2
book/exercises/002.md
View file

@ -1,5 +1,7 @@
# Exercise 2: Add a new file to the table of contents
> This page reuses CC BY 4.0 licensed content from {cite:t}`template`. {fa}`quote-left`{ref}`Find out more here.<external_resources>`
Let's continue by adding one additional step. Let's add a file to the table of contents! the `_toc.yml` contains a list of all the files to be shown in your book-website. Let's add a file which is not in the table of contents yet!
> Can you add the file named `file_to_be_added_to_toc.md` to the book website?

2
book/exercises/003.md
View file

@ -1,5 +1,7 @@
# Exercise 3: Change book configuration
> This page reuses CC BY 4.0 licensed content from {cite:t}`template`. {fa}`quote-left`{ref}`Find out more here.<external_resources>`
As we've added some content by now, let's make this book a bit more personal! We'll make some changes to the `_config.yml` file which changes the configuration of the book website.
> 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?

2
book/exercises/004.md
View file

@ -1,5 +1,7 @@
# Exercise 4: _Your_ Version of the Book
> This page reuses CC BY 4.0 licensed content from {cite:t}`template`. {fa}`quote-left`{ref}`Find out more here.<external_resources>`
By now, we've covered the essentials: content files, `_toc.yml` and `_config.yml`. But what if you want to make some changes but don't want to share them directly with the general public of your book website? Or what if you have some work-in-progress that you want to share with colleagues? You need a version of your book! Let's try and do that! Later on, you'll probably want to merge your newest version back into the original book. That's what we'll do in [](./005.md).
> Can you make a new branch of your book with an additional file `file_on_new_version.md` and view it online?

2
book/exercises/005.md
View file

@ -1,5 +1,7 @@
# Exercise 5: Merge your version in the original book
> This page reuses CC BY 4.0 licensed content from {cite:t}`template`. {fa}`quote-left`{ref}`Find out more here.<external_resources>`
In [](./004.md) you created your own version of a book. But it would be a pity if you never contribute back to the original book right? Probably your additions are very useful there too! You'll merge you version of the book which is stored on a branch into the original book which is on main. If there've been some changes on that main branch in the meantime, git will take care of that!
> Can you merge your branch into `main` with a pull request?

2
book/exercises/006.md
View file

@ -1,5 +1,7 @@
# Exercise 6: Contribute to the book of somebody else
> This page reuses CC BY 4.0 licensed content from {cite:t}`template`. {fa}`quote-left`{ref}`Find out more here.<external_resources>`
```{tip}
For this exercise you will need a partner, as well as your own book. In the first part, each of you will make a change in the book of the other, then request the other to review and merge the change. In the second part, you will go back to your book and accept the change made by your partner.
```

2
book/exercises/summary.md
View file

@ -1,5 +1,7 @@
# Summary of exercises: All Exercises
> This page reuses CC BY 4.0 licensed content from {cite:t}`template`. {fa}`quote-left`{ref}`Find out more here.<external_resources>`
With the exercises, you did all the steps of our TeachBooks workflow!
```{figure} ../figures/TeachBooks_flowchart.svg