admin2/manual_teachbooks
1
0
Fork 0
mirror of https://github.com/TeachBooks/manual.git synced 2026-11-12 22:35:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: multiple branches

Browse source
This commit is contained in:
Severin 2024-03-04 10:20:44 +01:00
parent d7dcea9487
commit efe1133062
1 changed files with 13 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

15
book/workflows/github.md
View file

@ -29,6 +29,17 @@ Wait a few minutes for the website to be deployed, if you're curious, have a loo
![alt text](../images/image-8.png)
When the workflow has finished, visit your build book at https://<username>.github.io/<repository_name> (case sensitive). For our example it is: https://dummystudent-Tom.github.io/My_own_book:
When the workflow has finished, visit your build book at `https://<username>.github.io/<repository_name>` (case sensitive). For our example it is: https://dummystudent-Tom.github.io/My_own_book:
![alt text](../images/image-9.png)
---
It is possible to have multiple versions of a book published at once, by creating another Git branch (e.g. `draft` or `dev`).
For each branch, the respective book is published at `https://<username>.github.io/<bookname>/<branchname>`.
Technical note: for convenience, just `.../<bookname>/` redirects to `.../<bookname>/book/`, which is itself an alias (a symlink) for
`.../<bookname>/main/`.
To learn more about how we do this, please see the [GitHub Actions documentation](https://docs.github.com/en/actions) and our deployment pipeline configuration file `.github/workflows/deploy-book-ghpages.yml` [here](https://github.com/TeachBooks/template/blob/main/.github/workflows/deploy-book-ghpages.yml).
![alt text](../images/image-9.png)