From 9839e85bc234ccf40660bfa5ae399353307ea69c Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sun, 26 Jan 2025 20:12:09 +0100 Subject: [PATCH 1/5] citations --> topics --- book/exercises/001.md | 4 +++- book/exercises/002.md | 4 +++- book/exercises/003.md | 4 +++- book/exercises/004.md | 4 +++- book/exercises/005.md | 4 +++- book/exercises/006.md | 4 +++- 6 files changed, 18 insertions(+), 6 deletions(-) diff --git a/book/exercises/001.md b/book/exercises/001.md index eb58f9d..0c481a2 100644 --- a/book/exercises/001.md +++ b/book/exercises/001.md @@ -2,7 +2,9 @@ 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? +::::::{topic} +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//`) - {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! diff --git a/book/exercises/002.md b/book/exercises/002.md index c38ec81..170ad3c 100644 --- a/book/exercises/002.md +++ b/book/exercises/002.md @@ -2,7 +2,9 @@ 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? +::::::{topic} +Can you add the file named `file_to_be_added_to_toc.md` to the book website? +:::::: 1. Go to the {octicon}`code;1em` `Code` - `Book` directory of your GitHub repository and find the location of `file_to_be_added_to_toc.md` 2. Go to the the file `book/_toc.yml` on your GitHub repository - {octicon}`code;1em` `Code` - `Book` - `_toc.yml` - {octicon}`pencil;1em` `Edit this file` diff --git a/book/exercises/003.md b/book/exercises/003.md index e1ef4b4..e0cd370 100644 --- a/book/exercises/003.md +++ b/book/exercises/003.md @@ -2,7 +2,9 @@ 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? +::::::{topic} +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? +:::::: 1. Go to the the file `book/_config.yml` on your GitHub repository - {octicon}`code;1em` `Code` - `Book` - `_config.yml` - {octicon}`pencil;1em` `Edit this file` 2. In the `Edit` field, change the author which will be shown in the footer of the book website. diff --git a/book/exercises/004.md b/book/exercises/004.md index dccea19..15d1227 100644 --- a/book/exercises/004.md +++ b/book/exercises/004.md @@ -2,7 +2,9 @@ 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? +::::::{topic} +Can you make a new branch of your book with an additional file `file_on_new_version.md` and view it online? +:::::: 1. Add a new Issue to let people know you're working on something by going to your repository - {octicon}`issue-opened;1em` `Issues` - `New issue` (note that is not required for making your own version, but it's good practice so that people know where you're working on) 2. Add a title and description, eg. `Added some content` diff --git a/book/exercises/005.md b/book/exercises/005.md index 9b078b1..0cdbf48 100644 --- a/book/exercises/005.md +++ b/book/exercises/005.md @@ -2,7 +2,9 @@ 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? +::::::{topic} +Can you merge your branch into `main` with a pull request? +:::::: 1. Go to your repository homepage. Probably, it will have big yellow announcement saying {octicon}`git-branch;1em` `1- had recent pushes minutes ago - Compare & Pull request`. We'll ignore that for now and do it manually. 2. Go to the pull request page on your repository homepage - {octicon}`git-pull-request;1em` and click `New pull request` diff --git a/book/exercises/006.md b/book/exercises/006.md index a256af5..f56a6ab 100644 --- a/book/exercises/006.md +++ b/book/exercises/006.md @@ -10,7 +10,9 @@ So far you did everything on your own, within a single repository. However, book The fork-pull request workflow is very common in open-source projects. It allows people to work independently without asking for access or worrying about affecting the original source code, as well as give the original author of the code a clear way to review the changes and decide if they want to include them in the original repository. ``` -> Can you fork a book repository of someone else, make changes and contribute back? +::::::{topic} +Can you fork a book repository of someone else, make changes and contribute back? +:::::: ```{tip} This part describes how you can make a change in the book of someone else. From 262c07df11fdce2741a19bb8ced97d351422fac2 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sun, 26 Jan 2025 20:17:52 +0100 Subject: [PATCH 2/5] Fix topics --- book/exercises/001.md | 2 +- book/exercises/002.md | 2 +- book/exercises/003.md | 2 +- book/exercises/004.md | 2 +- book/exercises/005.md | 2 +- book/exercises/006.md | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/book/exercises/001.md b/book/exercises/001.md index 0c481a2..0865c21 100644 --- a/book/exercises/001.md +++ b/book/exercises/001.md @@ -2,7 +2,7 @@ Let's start with the most basic edit: add some text to a file and see that the website is updated. -::::::{topic} +::::::{topic} Exercise objective Can you add some content to the intro page? :::::: diff --git a/book/exercises/002.md b/book/exercises/002.md index 170ad3c..df5eee8 100644 --- a/book/exercises/002.md +++ b/book/exercises/002.md @@ -2,7 +2,7 @@ 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! -::::::{topic} +::::::{topic} Exercise objective Can you add the file named `file_to_be_added_to_toc.md` to the book website? :::::: diff --git a/book/exercises/003.md b/book/exercises/003.md index e0cd370..a53e9a4 100644 --- a/book/exercises/003.md +++ b/book/exercises/003.md @@ -2,7 +2,7 @@ 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. -::::::{topic} +::::::{topic} Exercise objective 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? :::::: diff --git a/book/exercises/004.md b/book/exercises/004.md index 15d1227..8f2c172 100644 --- a/book/exercises/004.md +++ b/book/exercises/004.md @@ -2,7 +2,7 @@ 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). -::::::{topic} +::::::{topic} Exercise objective Can you make a new branch of your book with an additional file `file_on_new_version.md` and view it online? :::::: diff --git a/book/exercises/005.md b/book/exercises/005.md index 0cdbf48..db67832 100644 --- a/book/exercises/005.md +++ b/book/exercises/005.md @@ -2,7 +2,7 @@ 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! -::::::{topic} +::::::{topic} Exercise objective Can you merge your branch into `main` with a pull request? :::::: diff --git a/book/exercises/006.md b/book/exercises/006.md index f56a6ab..9287d06 100644 --- a/book/exercises/006.md +++ b/book/exercises/006.md @@ -10,7 +10,7 @@ So far you did everything on your own, within a single repository. However, book The fork-pull request workflow is very common in open-source projects. It allows people to work independently without asking for access or worrying about affecting the original source code, as well as give the original author of the code a clear way to review the changes and decide if they want to include them in the original repository. ``` -::::::{topic} +::::::{topic} Exercise objective Can you fork a book repository of someone else, make changes and contribute back? :::::: From 2b9cf7078dbb80c8d7f3978a73bc2fd6a1fb9ef0 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sun, 26 Jan 2025 20:18:36 +0100 Subject: [PATCH 3/5] typo --- book/credits.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/credits.md b/book/credits.md index 695c38e..89b23d8 100644 --- a/book/credits.md +++ b/book/credits.md @@ -7,7 +7,7 @@ You can refer to this book as: You can refer to individual chapters or pages within this book as: -> ``. In `<editors>` (`<year>`) _`<title>`_. `<url to specific page on bbook website>`. Source files at `<link to specific commit / file in github repo` +> `<Title of Chapter or Page>`. In `<editors>` (`<year>`) _`<title>`_. `<url to specific page on book website>`. Source files at `<link to specific commit / file in github repo` We anticipate that the content of this book will change significantly. Therefore, we recommend using the source code directly with the citation above that refers to the GitHub repository and lists the date and name of the file. Although content will be added over time, chapter titles and URL's in this book are expected to remain relatively static. However, we make no guarantee, so if it is important for you to reference a specific location/commit within the book. From 9269cf19de991d62761d05c704b0ac6605ea7a50 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg <t.r.vanwoudenberg@tudelft.nl> Date: Sun, 26 Jan 2025 20:20:11 +0100 Subject: [PATCH 4/5] remove unnecessary exercise thing in main --- book/exercises.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/book/exercises.md b/book/exercises.md index 4dfee99..a1fa545 100644 --- a/book/exercises.md +++ b/book/exercises.md @@ -1,10 +1,6 @@ # Exercises -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). -``` +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. We welcome you to 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): From 5c8df6bfa40e82390447796d1aac24f211d8454c Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg <t.r.vanwoudenberg@tudelft.nl> Date: Mon, 27 Jan 2025 12:07:15 +0100 Subject: [PATCH 5/5] Update exercises.md --- book/exercises.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/exercises.md b/book/exercises.md index a1fa545..e885fe5 100644 --- a/book/exercises.md +++ b/book/exercises.md @@ -1,6 +1,6 @@ # Exercises -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. We welcome you to Work through the exercises attached to this page (you can find them in the left sidebar). +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. We welcome you to 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):