Check changes online#
Note
This page is relevant for user type 4 and 5. When making changes to the book it can be useful to get an idea on how they will be realized in the online book. Whereas user type 5 can also build the book locally, user type 4 is more focused on the changes to the content.
However both users would certainly benefit from checking whether their changes look good in the book!
Now that you’ve pushed your changes online, it’s time to check the change in the online build book to make sure that your changes are processed correctly. For this step it is assumed you’re using TeachBook’s GitHub actions or TeachBook’s GitLab pipeline.
At the moment this is not possible. However, what you can do is ‘mirror’ your GitLab repository to GitHub. This will copy your content automatically (but maximum once every 5 minutes) to GitHub. This allows you to use the TeachBook’s GitHub actions.
Instructions on how to set up mirroring are provided here: https://docs.gitlab.com/ee/user/project/repository/mirror/push.html#set-up-a-push-mirror-from-gitlab-to-github
Once GitHub Pages is enabled and your book is published, you can view it by visiting the GitHub Pages URL for your repository. A summary can be seen under the Actions- All workflows - call-deploy-book in GitHub. It shows you a descriptive summary.
The summary also provides build error messages, which you might fix in a new commit.
If this is not activated yet, you can do so as describe here. Here you can also find more information.
You can keep on editing and checking your changes until you’re satisfied and ready for a review by a colleague.