mirror of
https://github.com/TeachBooks/template.git
synced 2026-11-13 06:35:52 +00:00
24 lines
No EOL
1.7 KiB
Markdown
24 lines
No EOL
1.7 KiB
Markdown
# 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.
|
|
|
|
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>`) - {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!
|
|
3. Click `Commit changes`
|
|
4. Add a message and 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 commit messageof 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`+`F5`to refresh the page (your browser keeps a cached version of website you recently visit, but we actually want the most up-to-date version!).
|
|
|
|
```{admonition} Check your understanding
|
|
: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?
|
|
``` |