From 744fe05a609d075a20d87e947e086147f43c50a8 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Wed, 4 Dec 2024 10:27:50 +0100 Subject: [PATCH] Make clear this only works on the main branch --- book/basic-features/utterances.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/book/basic-features/utterances.md b/book/basic-features/utterances.md index a4ef5ef..ade071f 100644 --- a/book/basic-features/utterances.md +++ b/book/basic-features/utterances.md @@ -4,10 +4,9 @@ [Utterances 🔮](https://utteranc.es/) is a lightweight open-source widget which allows you, your colleages and your students to discuss stuff in a blog post in your book. It is build on GitHub issues, so requires a GitHub repository, although the book can be hosted anywhere (so also on GitLab). -The [utterances website](https://utteranc.es/) clearly explains the required steps. One thing to take care of is how you want to do the issue-mapping with respect to multiple deployed versions (per branch): - - - `Issue title contains page URL` is useful if you want to isolate the comments on each of the branches. - - `Issue title contains page pathname`/`Issue title contains page title` is useful if you want to show the all comments on all different branches. +The [utterances website](https://utteranc.es/) clearly explains the required steps. One thing to take care of is that with the current setup of the [deploy book workflow on GitHub](../external/deploy-book-workflow/README.md), this widget only works on the primary branch. + +It's advised to use `Issue title contains page pathname`, because that url is most stable. The given script can be added anywhere in your book, just copy the html-script into your `.md`-file or a markdown cell in your `.ipynb`-file. The blogpost is not visible when you do a local build of the book, build it online or use a local python server as shown in {ref}`setup-local-server`. @@ -20,7 +19,7 @@ Below you see an example of this feature! ## Example discussion