Exercise 1: First file edit

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.

  1. Go to the the file book/intro.md on your GitHub repository (https://github.com/<your_username>/<your_repo_name>) - Code - Book - intro.md - Edit this file

  2. Add some text. Feeling brave? Have a look at the MyST cheat sheet. 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!

  5. Select Commit directly to the main branch (this adds your change your change to the default version instead of making a new one)

  6. Click Commit changes.

  7. Go to Actions - The most recent workflow run Update intro.md / the commit message of the commit you just made - Wait for it to finish - In the summary, click on the link of your book shown in the table Branches deployed and under Primary book at root

  8. Do you see your change? If you don’t see it click CTRL+F5/Control+F5to refresh the page (your browser keeps a cached version of website you recently visit, but we actually want the most up-to-date version!).

Hint

Watch the steps in action below

https://github.com/TeachBooks/template_figures/blob/main/excercise1.gif?raw=true

Fig. 1 Demonstration of all steps of this exercise, video available here#

Check your understanding
Check your understanding