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

Merge branch 'main' into publish

Browse source
This commit is contained in:
Tom van Woudenberg 2024-04-03 10:02:48 +02:00
commit 0ef23eb373
2 changed files with 12 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
book/workflows/figures/GitHub_desktop_fork.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 29 KiB

13
book/workflows/github.md
View file

@ -2,6 +2,9 @@
This page shows you how as an example how to create your own Jupyter Book. It including making an edit to a predefined book and hosting that book online. It doesn't elaborate on the collaborative functionalities of Git.
## Setting up and first baby-editing-steps
### Step 1: Fork book
To get started making your Jupyter Book with our functionalities, fork our template book https://github.com/TeachBooks/template :
![alt text](../images/image.png)
@ -10,6 +13,7 @@ Fill in a repository name, this name will be used in the future url of your book
![alt text](../images/image-1.png)
### Step 2: Setup GitHub pages with provided Actions
Set up the build of your website using GitHub pages by selecting under `Settings` - `Pages` - `Build and deployment` - `Source` - `GitHub Actions`:
![alt text](../images/image-2.png)
@ -18,6 +22,7 @@ Enable the predefined workflow to publish your book under `Actions` - `I underst
![alt text](../images/image-3.png)
### Step 3: Edit the book!
Edit a file under `Code` - `book` - A file of your choice - `Edit in place`, in the example below `book/intro.md` is edited:
![alt text](../images/image-5.png)
@ -27,10 +32,12 @@ Make your edit and `Commit changes` to `main` branch:
![alt text](../images/image-6.png)
![alt text](../images/image-7.png)
Wait a few minutes for the website to be deployed, if you're curious, have a look at the progress under `Actions` - `All wokflows`:
### Step 4: Have a look at the Action
Wait a few minutes for the website to be deployed, if you're curious, have a look at the progress under `Actions` - `All workflows`:
![alt text](../images/image-8.png)
### Step 5: Visit published website
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](https://dummystudent-Tom.github.io/My_own_book) :
![alt text](../images/image-9.png)
@ -44,4 +51,8 @@ Technical note: for convenience, just `.../<bookname>/` redirects to `.../<bookn
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).
## Working with GitHub Desktop on this fork
Whenever you continue working on this forked template using GitHub Desktop, make sure you select the `For my own purposes` option at `I'll be using this fork...` in the `Fork behavior` tab in `Repository settings`. This will streamline the process:
![alt text](./figures/GitHub_desktop_fork.png)