Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Disqus comment box and Facebook "like" and "share" buttons to the tutorial pages #484

Merged
merged 3 commits into from
Aug 9, 2015

Conversation

jslee02
Copy link
Member

@jslee02 jslee02 commented Aug 4, 2015

This pull request adds Disqus comment box and Facebook "like" and "share" buttons to the tutorial pages. The main reason Disqus is selected is that it allows anonymous comments. These components can be added to new pages by adding following script:

<div id="fb-root"></div>
<script>(function(d, s, id) {
  var js, fjs = d.getElementsByTagName(s)[0];
  if (d.getElementById(id)) return;
  js = d.createElement(s); js.id = id;
  js.src = "//connect.facebook.net/en_US/sdk.js#xfbml=1&version=v2.4";
  fjs.parentNode.insertBefore(js, fjs);
}(document, 'script', 'facebook-jssdk'));</script>

<div class="fb-like" data-href="http://dart.readthedocs.org/en/release-5.1/tutorials/introduction/" data-layout="button_count" data-action="like" data-show-faces="true" data-share="true"></div>

<div id="disqus_thread"></div>
<script type="text/javascript">
    /* * * CONFIGURATION VARIABLES * * */
    var disqus_shortname = 'dartsim';

    /* * * DON'T EDIT BELOW THIS LINE * * */
    (function() {
        var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
        dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
        (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
    })();
</script>
<noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript" rel="nofollow">comments powered by Disqus.</a></noscript>

Note that /release-5.1/tutorials/introduction/ should be updated for the new pages.

Here is a screenshot:
image
and an example page.

Project settings can be modified at https://dartsim.disqus.com if you have the privilege.

@jslee02 jslee02 added this to the DART 5.1.0 milestone Aug 4, 2015
@mxgrey
Copy link
Member

mxgrey commented Aug 5, 2015

Hah, that's pretty awesome. 👍

@psigen
Copy link
Collaborator

psigen commented Aug 5, 2015

@mkoval and I are very skeptical about the need for facebook integration on a documentation page...
😓 📵

@mxgrey
Copy link
Member

mxgrey commented Aug 5, 2015

It's meant to allow people to comment on the pages, for Q&A purposes.

I guess if this is mandatorily tied into Facebook accounts, then that would not be ideal. At least having an option for anonymity would probably be better.

@psigen
Copy link
Collaborator

psigen commented Aug 5, 2015

👍 for Feedback mechanism, 😿 for Facebook login, which I believe this solution does require.

@jslee02
Copy link
Member Author

jslee02 commented Aug 5, 2015

It seems Facebook comment systems doesn't allow anonymous comments. There is an alternative comment system Disqus which allows anonymous comments (called guest comment in Disqus). I chose Facebook over Disqus because Facebook looks more neat in terms of design to me, but anonymity is more important.

Replacing Facebook comment boxes with Disqus's ones.

@mxgrey
Copy link
Member

mxgrey commented Aug 5, 2015

Do you happen to know if there's a way to get notifications for new comments with Disqus (or with any other service)? It would be unfortunate if someone left a question there and none of us ever knew to answer it, because expert users don't check the tutorial pages regularly... or ever.

@jslee02
Copy link
Member Author

jslee02 commented Aug 5, 2015

Yes, there is a way. In order to get notifications, you need to sign-up Disqus and be a moderator of DART community. I can give you the privilege.

By the way, we still can keep the "like" and "share" buttons even though we don't use Facebook comment box. I think it could be one way to let people hear about DART through Facebook community. Thought?

@mxgrey
Copy link
Member

mxgrey commented Aug 5, 2015

Keeping the like and the share sounds totally fine to me. That way people can easily promote DART if they want to. As long as the commenting system allows for anonymity, I don't think there should be any problems.

@jslee02 jslee02 changed the title Add facebook comment box and "like" button to the tutorial pages Add Disqus comment box and Facebook "like" and "share" buttons to the tutorial pages Aug 5, 2015
@mkoval
Copy link
Collaborator

mkoval commented Aug 5, 2015

I can't think of a situation where I'd "Like" or "Share" a particular documentation page. It might make more sense to put one module (?), for DART as a whole, on each page. It makes a lot more sense to "Like" DART than to like the "DART 5.0 Installation Instructions". 😄

@mxgrey
Copy link
Member

mxgrey commented Aug 5, 2015

But... what if the doc page is like.... really good? You would want all your friends and relatives knowing about it? 😏

@psigen
Copy link
Collaborator

psigen commented Aug 5, 2015

Just to muddy the waters a bit, here is a list of blog commenting systems that I found:

  • Facebook
  • Google+
  • Disqus
  • Jetpack
  • Livefyre
  • Intense Debate
  • Vicomi

And some discussions about the pros/cons of each:

@mkoval
Copy link
Collaborator

mkoval commented Aug 5, 2015

@psigen All of those links are generally positive about Disqus. It seems like a reasonable option to me.

@psigen
Copy link
Collaborator

psigen commented Aug 6, 2015

Seems so. Well, I'm satisfied that Disqus is a reasonable option to try.

@jslee02
Copy link
Member Author

jslee02 commented Aug 9, 2015

Yeah, Disqus looks reasonable. Merging.

jslee02 added a commit that referenced this pull request Aug 9, 2015
Add Disqus comment box and Facebook "like" and "share" buttons to the tutorial pages
@jslee02 jslee02 merged commit 6e06410 into tutorials Aug 9, 2015
@jslee02 jslee02 deleted the tutorials_comment_system branch August 10, 2015 14:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants