diff --git a/README.md b/README.md index e638817..6b38bd6 100644 --- a/README.md +++ b/README.md @@ -8,17 +8,17 @@ The template allows you to start your own TeachBook and hosting that TeachBook o How to use the template is demonstrated in the figure below, all steps are elaborated on in the following step-by-step tutorial. -![Demonstration for a public repository](figures/teachbooks-template.gif) +![Demonstration for a public repository](https://github.com/TeachBooks/template_figures/blob/main/teachbooks-template.gif?raw=true) Video available [here](https://youtu.be/nN3Oi_MVvF0) -1. To get started making your TeachBook with our functionalities, use the [template TeachBook](https://github.com/TeachBooks/template) as template: +1. To get started making your TeachBook with our functionalities, use the [template TeachBook](https://github.com/TeachBooks/main/template) as template: -![Use template](figures/use_template.png) +![Use template](https://github.com/TeachBooks/template_figures/blob/main/use_template.png?raw=true) 2. Fill in a repository name, this name will be used in the future url of your book: -![Create new repository](figures/create_new_repository.png) +![Create new repository](https://github.com/TeachBooks/template_figures/blob/main/create_new_repository.png?raw=true) 3. You can choose for `Private` only if you've GitHub Pro, GitHub Team, GitHub Enterprise Cloud, or GitHub Enterprise Server. Otherwise, you won't be able to publish your TeachBook online. Furthermore, it prevents people from contributing to your book, making your book essentially 'closed' instead of 'open. @@ -26,22 +26,22 @@ Video available [here](https://youtu.be/nN3Oi_MVvF0) 5. You need to activate GitHub pages so that your website is published to the internet. As long as you don't do this your TeachBook is not published online. Actually, now that you've taken this template our workflow tries to publish it to GitHub pages, which you didn't have the chance to activate yet. That's why you probably received an email with 'call-deploy-book: Some jobs were not successful' and you see the failed job under `Initial commit`. You can activate GitHub pages by setting the source for GitHub pages to GitHub Actions under `Settings` - `Pages` - `Build and deployment` - `Source` - `GitHub Actions`: -![Activate GitHub Pages](figures/set_up_pages.png) +![Activate GitHub Pages](https://github.com/TeachBooks/template_figures/blob/main/set_up_pages.png?raw=true) 6. Make an edit to the TeachBook by editing and committing changes to one of the files in the `book/` subdirectory (available under `Code`). Now checkout the progress of the publishing workflow under `Actions` - `All workflows` - `call-deploy-book` -``. Remember, the first commit which is there has failed because GitHub Pages wasn't activated at the time of `Initial commit`, you could also re-run that job if you don't want to make an edit. You can do so by running the workflow from `Actions` - `All workflows` - `call-deploy-book` - `Initial commit` - `Re-run all jobs` - `Re-run jobs`: -![Action](figures/action_re-run.jpeg) +![Action](https://github.com/TeachBooks/template_figures/blob/main/action_re-run.jpeg?raw=true) 7. When the workflow has finished, visit your build TeachBook at `https://.github.io/` (case sensitive). For our example it is [https://dummydocent.github.io/test_book_from_template/](https://dummydocent.github.io/test_book_from_template/) for the shown repository. These links are visible in the action's summary as well, as shown in the figure of step 4. 8. Want to get started directly? Your book contains a few exercises to get your started! Visit `https://.github.io//exercises/exercises` (case sensitive) to get started with the first ones to get the basics of how to interact with your book on GitHub. -![exercises](figures/exercises.png) +![exercises](https://github.com/TeachBooks/template_figures/blob/main/exercises.png?raw=true) Additional tip: Set the repository website as your GitHub Pages website under `Code`- `About` - `Settings icon` - `Website` - `Use your GitHub Pages Website` -![GitHub pages as website](figures/use_github_pages_website.png) +![GitHub pages as website](https://github.com/TeachBooks/template_figures/blob/main/use_github_pages_website.png?raw=true) ## Features - A github repository structure for making a [Jupyter Book](https://github.com/executablebooks/jupyter-book) (`/book`) diff --git a/book/exercises/001.md b/book/exercises/001.md index 7441bf7..9e34e0a 100644 --- a/book/exercises/001.md +++ b/book/exercises/001.md @@ -15,7 +15,7 @@ Let's start with the most basic edit: add some text to a file and see that the w ```{hint} Watch the steps in action below :class: dropdown -![First file edit guide](/figures/excercise1.gif) +![First file edit guide](https://github.com/TeachBooks/template_figures/blob/main/excercise1.gif?raw=true) ``` ```{admonition} Check your understanding diff --git a/book/exercises/summary.md b/book/exercises/summary.md index e180a01..866137e 100644 --- a/book/exercises/summary.md +++ b/book/exercises/summary.md @@ -2,7 +2,7 @@ With the exercises, you did all the steps of our TeachBooks workflow! -```{figure} ../figures/TeachBooks_flowchart.svg +```{figure} https://github.com/TeachBooks/logos_and_visualisations/blob/main/TB_flowchart/TeachBooks_flowchart.svg?raw=true --- width: 500px align: center diff --git a/book/figures/TeachBooks_flowchart.svg b/book/figures/TeachBooks_flowchart.svg deleted file mode 100644 index 0ed6f33..0000000 --- a/book/figures/TeachBooks_flowchart.svg +++ /dev/null @@ -1,1006 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/book/figures/excercise1.gif b/book/figures/excercise1.gif deleted file mode 100644 index 738e6bd..0000000 Binary files a/book/figures/excercise1.gif and /dev/null differ diff --git a/figures/action_re-run.jpeg b/figures/action_re-run.jpeg deleted file mode 100644 index 03f897b..0000000 Binary files a/figures/action_re-run.jpeg and /dev/null differ diff --git a/figures/create_new_repository.png b/figures/create_new_repository.png deleted file mode 100644 index 58b4e5b..0000000 Binary files a/figures/create_new_repository.png and /dev/null differ diff --git a/figures/exercises.png b/figures/exercises.png deleted file mode 100644 index e66ab64..0000000 Binary files a/figures/exercises.png and /dev/null differ diff --git a/figures/set_up_pages.png b/figures/set_up_pages.png deleted file mode 100644 index ee2d57b..0000000 Binary files a/figures/set_up_pages.png and /dev/null differ diff --git a/figures/teachbooks-template.gif b/figures/teachbooks-template.gif deleted file mode 100644 index 50d6156..0000000 Binary files a/figures/teachbooks-template.gif and /dev/null differ diff --git a/figures/use_github_pages_website.png b/figures/use_github_pages_website.png deleted file mode 100644 index 76a03c3..0000000 Binary files a/figures/use_github_pages_website.png and /dev/null differ diff --git a/figures/use_template.png b/figures/use_template.png deleted file mode 100644 index c6d21fb..0000000 Binary files a/figures/use_template.png and /dev/null differ