diff --git a/book/workflows/figures/GitHub_desktop_fork.png b/book/workflows/figures/GitHub_desktop_fork.png new file mode 100644 index 0000000..3b12332 Binary files /dev/null and b/book/workflows/figures/GitHub_desktop_fork.png differ diff --git a/book/workflows/github.md b/book/workflows/github.md index 33c52bf..e8fce42 100644 --- a/book/workflows/github.md +++ b/book/workflows/github.md @@ -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://.github.io/` (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 `...//` redirects to `.../