Add comments for docs (and blog)

Hans5958 commented 3 years ago

I have an idea to add a comment section for the documentation (and the blog in the future).

I have two services in mind to use. Both using GitHub.

utterances (using GitHub Issues, popular, website, repository, privacy policy)
giscus (using GitHub Discussions, alternative to utterances, website, repository, privacy policy)

GrahamSH-LLK commented 3 years ago

I'm currently using Giscus on my website and it's really nice, but I don't know whether comments go well with docs?

Hans5958 commented 3 years ago

I'm currently using Giscus on my website and it's really nice, but I don't know whether comments go well with docs?

Well, I got the idea from Haxe's docs, which I found from utteranc.es. An example is https://haxe.org/manual/introduction-hello-world.html.

Hans5958 commented 2 years ago

I will continue on this when we got blog merged.

My plan is to use Giscus since I think it is mature enough to be sustainable. (They got sponsor, you know?)

Hans5958 commented 2 years ago

@WorldLanguages Say that I add giscus to our website, would that need significant changes on the privacy policy? (Just an addition of the list of third-party services is not significant)

WorldLanguages commented 2 years ago

@Hans5958 I think it would be fine

Hans5958 commented 2 years ago

Here are the screenshots until this day. The "code of conduct" link will be linked to the copy on the website. Please tell me whether I need to turn off comments on select pages. If there are no objections then I can start set up Giscus on this repo, some days later.

WorldLanguages commented 2 years ago

@Hans5958 How can we moderate those comments?

RIMOPA commented 2 years ago

@ Hans5958 How can we moderate those comments?

We can use the same thing we use to show Scratch comment warnings

Hans5958 commented 2 years ago

@WorldLanguages I think it's just like what you do on GitHub Discussions, you can remove messages, lock discussion, etc.

EDIT: Yeah, it is mentioned on the website.

How it works

When giscus loads, the GitHub Discussions search API is used to find the Discussion associated with the page based on a chosen mapping (URL, pathname, , etc.). If a matching discussion cannot be found, the giscus bot will automatically create a discussion the first time someone leaves a comment or reaction.</p> <p>To comment, visitors must authorize the <a href="https://github.com/apps/giscus">giscus app</a> to <a href="https://docs.github.com/en/developers/apps/identifying-and-authorizing-users-for-github-apps">post on their behalf</a> using the GitHub OAuth flow. Alternatively, visitors can comment on the GitHub Discussion directly. <strong>You can moderate the comments on GitHub.</strong></p> </blockquote> </div> </div> <div class="comment"> <div class="user"> <a rel="noreferrer nofollow" target="_blank" href="https://github.com/WorldLanguages"><img src="https://avatars.githubusercontent.com/u/17484114?v=4" />WorldLanguages</a> commented <strong> 2 years ago</strong> </div> <div class="markdown-body"> <p>Sounds good enough, since all comments end up on GitHub too</p> </div> </div> <div class="page-bar-simple"> </div> <div class="footer"> <ul class="body"> <li>© <script> document.write(new Date().getFullYear()) </script> Githubissues.</li> <li>Githubissues is a development platform for aggregating issues.</li> </ul> </div> <script src="https://cdn.jsdelivr.net/npm/jquery@3.5.1/dist/jquery.min.js"></script> <script src="/githubissues/assets/js.js"></script> <script src="/githubissues/assets/markdown.js"></script> <script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.4.0/build/highlight.min.js"></script> <script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.4.0/build/languages/go.min.js"></script> <script> hljs.highlightAll(); </script> </body> </html>

ScratchAddons / website-v2

Add comments for docs (and blog) #57

How it works