template/book/exercises/001.md
2024-12-13 15:20:52 +01:00

1.8 KiB

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. This exercise is ready for you at https://teachbooks.io/template/exercises/001

Can you add some content to the intro page? Let's start with just some text!

  1. Go to the source file of this page 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
  2. Add some text. You want to be create already, have a look at the MyST cheat sheet
  3. Click Commit changes
  4. Add a description of your change
  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 {octicon}play;1em Actions - The most recent workflow run Update intro.md / the name 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!).
:class: tip

Before moving on to the next exercise, make sure you understand the following:
1. Where are the contents of the book stored?
2. How can you edit a single file via the GitHub browser interface?
3. What is a commit and what role does it play in the editing process?
4. Given a specific GitHub repository, can you determine the URL of the book website?
5. Where is the book metadata stored?