mirror of
https://github.com/TeachBooks/template.git
synced 2026-11-12 22:25:52 +00:00
1.8 KiB
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!
- Go to the source file of this page on your GitHub repository (
https://github.com/<your_username>/<your_repo_name>) - {octicon}code;1emCode-Book-intro.md- {octicon}pencil;1emEdit this file - Add some text. You want to be create already, have a look at the MyST cheat sheet
- Click
Commit changes - Add a description of your change
- Select
Commit directly to the main branch(this adds your change your change to the default version instead of making a new one) - Click
Commit changes - Go to {octicon}
play;1emActions- The most recent workflow runUpdate 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 tableBranches deployedand underPrimary book at root - 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?