diff --git a/book/credits.md b/book/credits.md index abc7297..c9937d4 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>` from Delft University of Technology (`<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>` from Delft University of Technology (`<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. diff --git a/book/exercises.md b/book/exercises.md index 384416e..1c3ffe9 100644 --- a/book/exercises.md +++ b/book/exercises.md @@ -2,11 +2,7 @@ > This page reuses CC BY 4.0 licensed content from {cite:t}`template`. {fa}`quote-left`{ref}`Find out more here.<external_resources>` -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): diff --git a/book/exercises/001.md b/book/exercises/001.md index d0d5afb..0018831 100644 --- a/book/exercises/001.md +++ b/book/exercises/001.md @@ -4,7 +4,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} Exercise objective +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>` 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! diff --git a/book/exercises/002.md b/book/exercises/002.md index 9bf9ca7..a3c426b 100644 --- a/book/exercises/002.md +++ b/book/exercises/002.md @@ -4,7 +4,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} Exercise objective +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 5a4095b..77ddbf7 100644 --- a/book/exercises/003.md +++ b/book/exercises/003.md @@ -4,7 +4,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} 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? +:::::: 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 6adaa34..3120a69 100644 --- a/book/exercises/004.md +++ b/book/exercises/004.md @@ -4,7 +4,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} Exercise objective +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 3dd6234..6c8c1b6 100644 --- a/book/exercises/005.md +++ b/book/exercises/005.md @@ -4,7 +4,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} Exercise objective +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-<your_issue_title> had recent pushes <some> 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 ba0f926..f70ba91 100644 --- a/book/exercises/006.md +++ b/book/exercises/006.md @@ -12,7 +12,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} Exercise objective +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.