Merge branch 'github-workflow' into 'isabel_new_branch_cookbook_stuff'

Added GitHub forking tutorial

See merge request interactivetextbooks-citg/jupyter-book-manual!41
This commit is contained in:
Tom van Woudenberg 2024-03-01 11:58:15 +01:00
commit f2ad5a2aff
13 changed files with 38 additions and 1 deletions

View file

@ -21,6 +21,7 @@ parts:
sections: sections:
- file: workflows/git-merge-conflict - file: workflows/git-merge-conflict
- file: workflows/gitlab - file: workflows/gitlab
- file: workflows/github
- caption: Features - caption: Features
chapters: chapters:
- file: basic-features/overview - file: basic-features/overview

BIN
book/images/image-1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB

BIN
book/images/image-2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 104 KiB

BIN
book/images/image-3.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

BIN
book/images/image-4.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 96 KiB

BIN
book/images/image-5.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 96 KiB

BIN
book/images/image-6.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

BIN
book/images/image-7.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 111 KiB

BIN
book/images/image-8.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

BIN
book/images/image-9.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

BIN
book/images/image.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

34
book/workflows/github.md Normal file
View file

@ -0,0 +1,34 @@
# GitHub template
To get started making your Jupyter Book with our functionalities, fork our template book https://github.com/TeachBooks/template :
![alt text](../images/image.png)
Fill in a repository name, this name will be used in the future url of your book:
![alt text](../images/image-1.png)
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)
Enable the predefined workflow to publish your book under `Actions` - `I understand my workflows, go ahead an enable them`:
![alt text](../images/image-3.png)
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)
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`:
![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:
![alt text](../images/image-9.png)

View file

@ -2,4 +2,6 @@
```{warning} Under Construction! ```{warning} Under Construction!
This page will provide a workflow how to collaborate in Git and GitLab for different uses types. Every team might have a different workflow but this workflow is shown as an example and is used in the MUDE course in CEG. This page will provide a workflow how to collaborate in Git and GitLab for different uses types. Every team might have a different workflow but this workflow is shown as an example and is used in the MUDE course in CEG.
An alternative is to use Github and Github pages to publish your book.