diff --git a/book/_toc.yml b/book/_toc.yml index 758d4a2..0dbe8dc 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -21,6 +21,7 @@ parts: sections: - file: workflows/git-merge-conflict - file: workflows/gitlab + - file: workflows/github - caption: Features chapters: - file: basic-features/overview diff --git a/book/images/image-1.png b/book/images/image-1.png new file mode 100644 index 0000000..6364dcf Binary files /dev/null and b/book/images/image-1.png differ diff --git a/book/images/image-2.png b/book/images/image-2.png new file mode 100644 index 0000000..b981a19 Binary files /dev/null and b/book/images/image-2.png differ diff --git a/book/images/image-3.png b/book/images/image-3.png new file mode 100644 index 0000000..9b5a9c3 Binary files /dev/null and b/book/images/image-3.png differ diff --git a/book/images/image-4.png b/book/images/image-4.png new file mode 100644 index 0000000..7961d8e Binary files /dev/null and b/book/images/image-4.png differ diff --git a/book/images/image-5.png b/book/images/image-5.png new file mode 100644 index 0000000..7961d8e Binary files /dev/null and b/book/images/image-5.png differ diff --git a/book/images/image-6.png b/book/images/image-6.png new file mode 100644 index 0000000..419e9e7 Binary files /dev/null and b/book/images/image-6.png differ diff --git a/book/images/image-7.png b/book/images/image-7.png new file mode 100644 index 0000000..f6b167d Binary files /dev/null and b/book/images/image-7.png differ diff --git a/book/images/image-8.png b/book/images/image-8.png new file mode 100644 index 0000000..fdbf3b7 Binary files /dev/null and b/book/images/image-8.png differ diff --git a/book/images/image-9.png b/book/images/image-9.png new file mode 100644 index 0000000..1673249 Binary files /dev/null and b/book/images/image-9.png differ diff --git a/book/images/image.png b/book/images/image.png new file mode 100644 index 0000000..63fd66a Binary files /dev/null and b/book/images/image.png differ diff --git a/book/workflows/github.md b/book/workflows/github.md new file mode 100644 index 0000000..196a6e6 --- /dev/null +++ b/book/workflows/github.md @@ -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://.github.io/ (case sensitive). For our example it is: https://dummystudent-Tom.github.io/My_own_book: + +![alt text](../images/image-9.png) \ No newline at end of file diff --git a/book/workflows/overview.md b/book/workflows/overview.md index d77d16d..b202ace 100644 --- a/book/workflows/overview.md +++ b/book/workflows/overview.md @@ -2,4 +2,6 @@ ```{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. \ No newline at end of file +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. \ No newline at end of file