16
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.
|
||||
|
||||

|
||||

|
||||
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:
|
||||
|
||||

|
||||

|
||||
|
||||
2. Fill in a repository name, this name will be used in the future url of your book:
|
||||
|
||||

|
||||

|
||||
|
||||
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`:
|
||||
|
||||

|
||||

|
||||
|
||||
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` -`<the most recent workflow run>`. 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`:
|
||||
|
||||

|
||||

|
||||
|
||||
7. When the workflow has finished, visit your build TeachBook at `https://<username or organiszation_name>.github.io/<repository_name>` (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://<username or organiszation_name>.github.io/<repository_name>/exercises/exercises` (case sensitive) to get started with the first ones to get the basics of how to interact with your book on GitHub.
|
||||
|
||||

|
||||

|
||||
|
||||
Additional tip:
|
||||
Set the repository website as your GitHub Pages website under `Code`- `About` - `Settings icon` - `Website` - `Use your GitHub Pages Website`
|
||||
|
||||

|
||||

|
||||
|
||||
## Features
|
||||
- A github repository structure for making a [Jupyter Book](https://github.com/executablebooks/jupyter-book) (`/book`)
|
||||
|
|
|
|||
|
|
@ -15,14 +15,17 @@ Can you add some content to the intro page?
|
|||
7. Go to {octicon}`play;1em` `Actions` - The most recent workflow run `Update intro.md / the commit message of the commit you just made` - Wait for it to finish - In the summary, click on the link of your book shown in the table `Branches deployed` and under `Primary book at root`
|
||||
8. Do you see your change? If you don't see it click `CTRL`+`F5`/`Control`+`F5`to refresh the page (your browser keeps a cached version of website you recently visit, but we actually want the most up-to-date version!).
|
||||
|
||||
```{admonition} Check your understanding
|
||||
:class: note
|
||||
```{hint} Watch the steps in action below
|
||||
:class: dropdown
|
||||

|
||||
|
||||
Before moving on to the next exercise, make sure you understand the following:
|
||||
- Where are the contents of the book stored?
|
||||
- How can you edit a single file via the GitHub browser interface?
|
||||
- What is a commit and what role does it play in the editing process?
|
||||
- Given a specific GitHub repository, can you determine the URL of the book website?
|
||||
- How can you view the changes you made to the book?
|
||||
- What is the purpose of a commit message and description?
|
||||
```
|
||||
[Or watch the video here](https://youtu.be/gn1zBmmunco)
|
||||
```
|
||||
|
||||
:::{card} Check your understanding
|
||||
<iframe src="https://tudelft.h5p.com/content/1292494525712285897/embed" aria-label="Testing your knowledge" width="1088" height="637" frameborder="0" allowfullscreen="allowfullscreen" allow="autoplay *; geolocation *; microphone *; camera *; midi *; encrypted-media *"></iframe><script src="https://tudelft.h5p.com/js/h5p-resizer.js" charset="UTF-8"></script>
|
||||
:::
|
||||
|
||||
:::{card} Check your understanding
|
||||
<iframe src="https://tudelft.h5p.com/content/1292493455522610637/embed" aria-label="Testing more Teachbooks knowledge" width="1088" height="637" frameborder="0" allowfullscreen="allowfullscreen" allow="autoplay *; geolocation *; microphone *; camera *; midi *; encrypted-media *"></iframe><script src="https://tudelft.h5p.com/js/h5p-resizer.js" charset="UTF-8"></script>
|
||||
:::
|
||||
|
|
@ -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
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 79 KiB |
|
Before Width: | Height: | Size: 193 KiB |
|
Before Width: | Height: | Size: 45 KiB |
|
Before Width: | Height: | Size: 41 KiB |
|
Before Width: | Height: | Size: 87 KiB |
|
Before Width: | Height: | Size: 3.2 MiB |
|
Before Width: | Height: | Size: 76 KiB |
|
Before Width: | Height: | Size: 83 KiB |