Review Request 119991: Use Juvia to add comments on the API class pages

Sat Aug 30 08:15:39 UTC 2014

> On Aug. 29, 2014, 2:42 p.m., Matthew Dawson wrote:
> > This looks really awesome.  Is there some way for maintainers (or other interested parties) to watch their framework's comments, to be on the look out for any interesting conversation?  Users may make comments about the API's that would be good to follow up on.
> > 
> > Thanks for looking into this!
> 
> Denis Steckelmacher wrote:
>     I agree that having the comments forwarded by email to a mailing list (or the maintainers) would have been wonderful, but I have not seen how this could be enabled in the (minimalistic) admin panel of Juvia. I have never developed anything in Ruby but I'll have a look at what Juvia does when a comment is posted. A hack so that comments are forwared somewhere may be possible.
> 
> Denis Steckelmacher wrote:
>     Okay, for what I've seen in the source code (here: https://github.com/phusion/juvia/blob/master/app/models/comment.rb#L22), an email should be sent to the owner of the site on which a comment has been posted. I'm currently the owner of "KDE Frameworks 5" (the Juvia site for the comments), and I've not received any email. If I remember well, getting emails to work with a Ruby website is a bit tricky. I can change my email to something publicly viewable or at least more easily testable if need be.
> 
> Albert Astals Cid wrote:
>     Yeha, check with sysadmins why emails are not working and then maybe create a api-kde-comments at kde.org mailing list or something that people can subscribe to?
> 
> Ben Cooksley wrote:
>     Emails should be fixed now, I did everything but reconfigure the MTA to deliver outbound mail when setting up the system.

Yes, I confirm that comments are now working. I posted a test comment and I received this email:

> A new comment has been posted on "KDE Frameworks 5"
>
> Topic     : KArchive - KCompressionDevice Class Reference (https://commenting.kde.org/admin/topics/3)
> Name      : steckdenis
> Email     : steckdenis at yahoo.fr
> IP        : SNIP
> User agent: Mozilla/5.0 (X11; Linux x86_64; rv:30.0) Gecko/20100101 Firefox/30.0
> Referer   : Unknown
> 
> Test comment

Once a mailing-list is created, I can change my e-mail address so that the mailing-list receives the comments. One small problem, though, is that the URL given in the email points to the admin interface instead of the API page on which the comment has been posted. I'll see if it is possible to slightly change a Juvia template so that the API doc url is used, it should be easy (https://github.com/phusion/juvia/blob/master/app/views/mailer/comment_posted.text.erb is the file to change, and replacing `admin_topic_url(@comment.topic)` with `@comment.topic.url` may work).

- Denis

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/119991/#review65506
-----------------------------------------------------------

On Aug. 29, 2014, 2:16 p.m., Denis Steckelmacher wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://git.reviewboard.kde.org/r/119991/
> -----------------------------------------------------------
> 
> (Updated Aug. 29, 2014, 2:16 p.m.)
> 
> 
> Review request for KDE Frameworks and Aurélien Gâteau.
> 
> 
> Repository: kapidox
> 
> 
> Description
> -------
> 
> Juvia is a Free Software commenting system that can easily be used on static websites like api.kde.org. An instance of Juvia has just been installed on commenting.kde.org (many thanks to Ben Cooksley!), and this patch adds support for it to api.kde.org.
> 
> The users can now comment class pages. The comments are disabled (no comment box nor anything else appears) on the main page of each framework, on the Frameworks 5 index page and on any other page that does not directly concern a class. I've done that in order to avoid cluttering important pages with comments, but if you think that having comments on all the pages (or a bigger subset of them) is desirable, it is very easy to change. Personally, I would avoid having comments on the main pages, so that any spam, if the automatic Akismet filter does not work, will not be too visible.
> 
> A screenshot is linked to this review request and shows how the comments have been integrated (I slightly modified the built-in Juvia style so that Doxygen and KDE colors are used).
> 
> 
> Diffs
> -----
> 
>   src/kapidox/data/htmlresource/kde.css e173dfe 
>   src/kapidox/data/templates/comments.html PRE-CREATION 
>   src/kapidox/data/templates/doxygen.html d00e14e 
> 
> Diff: https://git.reviewboard.kde.org/r/119991/diff/
> 
> 
> Testing
> -------
> 
> Posting a comment works, and comments can be viewed. They also appear in the admin interface of Juvia (I've now deleted these comments). I posted comments on different classes and in different frameworks in order to test that namespacing works correctly.
> 
> 
> File Attachments
> ----------------
> 
> Comments on api.kde.org
>   https://git.reviewboard.kde.org/media/uploaded/files/2014/08/29/278299d8-18a6-46a0-ada5-1b6452a3276f__apidox-comments-1.png
> 
> 
> Thanks,
> 
> Denis Steckelmacher
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20140830/2db307f3/attachment.html>