diff --git a/book/workflows/check_changes_online.md b/book/workflows/check_changes_online.md index d80f047..818d4c7 100644 --- a/book/workflows/check_changes_online.md +++ b/book/workflows/check_changes_online.md @@ -1,5 +1,12 @@ # 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. `````{tab-set} @@ -9,11 +16,21 @@ At the moment this is not possible, but the workflow will soon be the same as fo ```` ````{tab-item} In GitHub -- Wait for the action to finish (GitHub Desktop shows progress if its part of a pull request, VS Code shows progress with the GitHub Actions addon) -- Visit the website of your build book +1. Enable GitHub Pages on your repositery. Note that if you use the Teachbooks template this is probably already done! -```{error} To be written -``` +2. Once your book files are pushed to your GitHub repository you can view the book. Make sure you wait for the action to finish (GitHub Desktop shows progress if its part of a pull request, VS Code shows progress with the GitHub Actions addon). + +3. Viewing the Book: Once GitHub Pages is enabled and your book is published, you can view it by visiting the GitHub Pages URL for your repository. The URL will typically be in the format https://.github.io/. + +Alternatively you can find it in the settings + +- Go to your GitHub repository's settings. +- Scroll down to the "GitHub Pages" section (left side-bar: pages) +- Copy the link or click on `Visit site` + +
+ Example Image +
````` You can keep on [editing](edit_book) and checking your changes until you're satisfied and ready for a review by a colleague. \ No newline at end of file diff --git a/book/workflows/edit_book.md b/book/workflows/edit_book.md index 7be8715..d565c8c 100644 --- a/book/workflows/edit_book.md +++ b/book/workflows/edit_book.md @@ -89,10 +89,8 @@ You can edit it and commit the changes in the same manner as with markdown (.md) ```````` ````````{tab-item} ... user type 4 ... -**... for ...** - ```````{tab-set} -``````{tab-item} ... a brand new version (branch)... +``````{tab-item} ... for a brand new version (branch)... **... by (1) making changes on a single or multiple file(s)
(2) selecting changes to be added to the Git-timeline (staging)
@@ -159,7 +157,7 @@ Alternatively, you can also click on `Push origin` in the top bar. ````` `````` -``````{tab-item} ... an existing version (branch)... +``````{tab-item} ... for an existing version (branch)... **... by (1) regularly obtaining updates from colleagues from GitLab/GitHub (pulling),
(2) solving potential incompatible changes (merging conflicts),
@@ -281,7 +279,7 @@ Alternatively, you can also click on `Push origin` in the top bar. ````````{tab-item} ... User type 5 ... ```````{tab-set} -``````{tab-item} ... brand new version (branch) +``````{tab-item} ... for brand new version (branch) **... by (1) making changes on a single or multiple file(s)
(2) checking changes locally,
@@ -393,7 +391,7 @@ Python stuff? ````` `````` -``````{tab-item} ... existing version (branch) +``````{tab-item} ... for an existing version (branch) **... by (1) regularly obtaining updates from colleagues from GitLab/GitHub (pulling),
(2) solving potential incompatible changes (merging conflicts),
diff --git a/book/workflows/figures/GitHubPages.PNG b/book/workflows/figures/GitHubPages.PNG new file mode 100644 index 0000000..84cc31f Binary files /dev/null and b/book/workflows/figures/GitHubPages.PNG differ