[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-frameworks-devel
Subject: Re: Review Request 119991: Use Juvia to add comments on the API class pages
From: "Ben Cooksley" <bcooksley () kde ! org>
Date: 2014-09-02 10:06:29
Message-ID: 20140902100629.11808.58047 () probe ! kde ! org
[Download RAW message or body]
--===============0744718296931915316==
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 8bit
> 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@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.
> Denis Steckelmacher wrote:
> 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@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).
> Ben Cooksley wrote:
> Please file a ticket to request the creation of the mailing list.
>
> Denis Steckelmacher wrote:
> The mailing list has been created (api-comments@kde.org, \
> https://mail.kde.org/mailman/listinfo/api-comments), and I've changed the \
> configuration of Juvia so that comments posted on api.kde.org get forwarded to the \
> mailing-list. I have subscribed noreply@kde.org (the email address from which the \
> Juvia emails come from) to api-comments@kde.org, and I've posted a comment. The \
> archives of api-comments@kde.org does not list it though, and I have received no \
> e-mail (not even an e-mail asking for moderation). Is it normal or has something \
> gone wrong?
The archives didn't list it because archiving wasn't enabled - which I have now \
fixed. You haven't received an email likely because the mail wasn't held for \
moderation (because the mailing list config is set to allow non-members to post) and \
you aren't subscribed to the mailing list. One can be a moderator for a mailing list \
without being subscribed to it.
- Ben
-----------------------------------------------------------
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
>
>
--===============0744718296931915316==
MIME-Version: 1.0
Content-Type: text/html; charset="utf-8"
Content-Transfer-Encoding: 8bit
<html>
<body>
<div style="font-family: Verdana, Arial, Helvetica, Sans-Serif;">
<table bgcolor="#f9f3c9" width="100%" cellpadding="12" style="border: 1px #c9c399 \
solid; border-radius: 6px; -moz-border-radius: 6px; -webkit-border-radius: 6px;"> \
<tr> <td>
This is an automatically generated e-mail. To reply, visit:
<a href="https://git.reviewboard.kde.org/r/119991/">https://git.reviewboard.kde.org/r/119991/</a>
</td>
</tr>
</table>
<br />
<blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; padding-left: \
10px;"> <p style="margin-top: 0;">On August 29th, 2014, 2:42 p.m. UTC, <b>Matthew \
Dawson</b> wrote:</p> <blockquote style="margin-left: 1em; border-left: 2px solid \
#d0d0d0; padding-left: 10px;"> <pre style="white-space: pre-wrap; white-space: \
-moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;"><p style="padding: 0;text-rendering: inherit;margin: 0;line-height: \
inherit;white-space: inherit;">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.</p> <p style="padding: 0;text-rendering: \
inherit;margin: 0;line-height: inherit;white-space: inherit;">Thanks for looking into \
this!</p></pre> </blockquote>
<p>On August 29th, 2014, 2:59 p.m. UTC, <b>Denis Steckelmacher</b> wrote:</p>
<blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; padding-left: \
10px;"> <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: \
-pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><p style="padding: \
0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: inherit;">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.</p></pre> </blockquote>
<p>On August 29th, 2014, 3:09 p.m. UTC, <b>Denis Steckelmacher</b> wrote:</p>
<blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; padding-left: \
10px;"> <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: \
-pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><p style="padding: \
0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: inherit;">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.</p></pre> </blockquote>
<p>On August 29th, 2014, 3:11 p.m. UTC, <b>Albert Astals Cid</b> wrote:</p>
<blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; padding-left: \
10px;"> <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: \
-pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><p style="padding: \
0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: inherit;">Yeha, \
check with sysadmins why emails are not working and then maybe create a \
api-kde-comments@kde.org mailing list or something that people can subscribe \
to?</p></pre> </blockquote>
<p>On August 30th, 2014, 1:23 a.m. UTC, <b>Ben Cooksley</b> wrote:</p>
<blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; padding-left: \
10px;"> <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: \
-pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><p style="padding: \
0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: \
inherit;">Emails should be fixed now, I did everything but reconfigure the MTA to \
deliver outbound mail when setting up the system.</p></pre> </blockquote>
<p>On August 30th, 2014, 8:15 a.m. UTC, <b>Denis Steckelmacher</b> wrote:</p>
<blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; padding-left: \
10px;"> <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: \
-pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><p style="padding: \
0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: inherit;">Yes, \
I confirm that comments are now working. I posted a test comment and I received this \
email:</p> <blockquote style="text-rendering: inherit;padding: 0 0 0 1em;border-left: \
1px solid #bbb;white-space: normal;margin: 0 0 0 0.5em;line-height: inherit;"> <p \
style="padding: 0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: \
inherit;">A new comment has been posted on "KDE Frameworks 5"</p> <p style="padding: \
0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: inherit;">Topic \
: KArchive - KCompressionDevice Class Reference \
(https://commenting.kde.org/admin/topics/3)<br style="padding: 0;text-rendering: \
inherit;margin: 0;line-height: inherit;white-space: normal;" /> Name : \
steckdenis<br style="padding: 0;text-rendering: inherit;margin: 0;line-height: \
inherit;white-space: normal;" /> Email : steckdenis@yahoo.fr<br style="padding: \
0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: normal;" /> IP \
: SNIP<br style="padding: 0;text-rendering: inherit;margin: 0;line-height: \
inherit;white-space: normal;" /> User agent: Mozilla/5.0 (X11; Linux x86_64; rv:30.0) \
Gecko/20100101 Firefox/30.0<br style="padding: 0;text-rendering: inherit;margin: \
0;line-height: inherit;white-space: normal;" /> Referer : Unknown</p>
<p style="padding: 0;text-rendering: inherit;margin: 0;line-height: \
inherit;white-space: inherit;">Test comment</p> </blockquote>
<p style="padding: 0;text-rendering: inherit;margin: 0;line-height: \
inherit;white-space: inherit;">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 <code style="text-rendering: inherit;color: \
#4444cc;padding: 0;white-space: normal;margin: 0;line-height: \
inherit;">admin_topic_url(@comment.topic)</code> with <code style="text-rendering: \
inherit;color: #4444cc;padding: 0;white-space: normal;margin: 0;line-height: \
inherit;">@comment.topic.url</code> may work).</p></pre> </blockquote>
<p>On August 30th, 2014, 12:55 p.m. UTC, <b>Ben Cooksley</b> wrote:</p>
<blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; padding-left: \
10px;"> <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: \
-pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><p style="padding: \
0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: \
inherit;">Please file a ticket to request the creation of the mailing list.</p></pre> \
</blockquote>
<p>On September 1st, 2014, 12:10 p.m. UTC, <b>Denis Steckelmacher</b> wrote:</p>
<blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; padding-left: \
10px;"> <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: \
-pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><p style="padding: \
0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: inherit;">The \
mailing list has been created (api-comments@kde.org, \
https://mail.kde.org/mailman/listinfo/api-comments), and I've changed the \
configuration of Juvia so that comments posted on api.kde.org get forwarded to the \
mailing-list. I have subscribed noreply@kde.org (the email address from which the \
Juvia emails come from) to api-comments@kde.org, and I've posted a comment. The \
archives of api-comments@kde.org does not list it though, and I have received no \
e-mail (not even an e-mail asking for moderation). Is it normal or has something gone \
wrong?</p></pre> </blockquote>
</blockquote>
<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: \
-pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;"><p style="padding: \
0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: inherit;">The \
archives didn't list it because archiving wasn't enabled - which I have now fixed. \
You haven't received an email likely because the mail wasn't held for moderation \
(because the mailing list config is set to allow non-members to post) and you aren't \
subscribed to the mailing list. One can be a moderator for a mailing list without \
being subscribed to it.</p></pre> <br />
<p>- Ben</p>
<br />
<p>On August 29th, 2014, 2:16 p.m. UTC, Denis Steckelmacher wrote:</p>
<table bgcolor="#fefadf" width="100%" cellspacing="0" cellpadding="12" style="border: \
1px #888a85 solid; border-radius: 6px; -moz-border-radius: 6px; \
-webkit-border-radius: 6px;"> <tr>
<td>
<div>Review request for KDE Frameworks and Aurélien Gâteau.</div>
<div>By Denis Steckelmacher.</div>
<p style="color: grey;"><i>Updated Aug. 29, 2014, 2:16 p.m.</i></p>
<div style="margin-top: 1.5em;">
<b style="color: #575012; font-size: 10pt;">Repository: </b>
kapidox
</div>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Description </h1>
<table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" \
style="border: 1px solid #b8b5a0"> <tr>
<td>
<pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: \
-moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;"><p style="padding: 0;text-rendering: inherit;margin: 0;line-height: \
inherit;white-space: inherit;">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.</p> <p style="padding: 0;text-rendering: \
inherit;margin: 0;line-height: inherit;white-space: inherit;">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.</p> <p \
style="padding: 0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: \
inherit;">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).</p></pre> </td>
</tr>
</table>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Testing </h1>
<table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" style="border: \
1px solid #b8b5a0"> <tr>
<td>
<pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: \
-moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;"><p style="padding: 0;text-rendering: inherit;margin: 0;line-height: \
inherit;white-space: inherit;">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.</p></pre> </td>
</tr>
</table>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Diffs</b> </h1>
<ul style="margin-left: 3em; padding-left: 0;">
<li>src/kapidox/data/htmlresource/kde.css <span style="color: \
grey">(e173dfe)</span></li>
<li>src/kapidox/data/templates/comments.html <span style="color: \
grey">(PRE-CREATION)</span></li>
<li>src/kapidox/data/templates/doxygen.html <span style="color: \
grey">(d00e14e)</span></li>
</ul>
<p><a href="https://git.reviewboard.kde.org/r/119991/diff/" style="margin-left: \
3em;">View Diff</a></p>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">File Attachments \
</h1>
<li><a href="https://git.reviewboard.kde.org/media/uploaded/files/2014/08/29/278299d8-18a6-46a0-ada5-1b6452a3276f__apidox-comments-1.png">Comments \
on api.kde.org</a></li>
</ul>
</td>
</tr>
</table>
</div>
</body>
</html>
--===============0744718296931915316==--
_______________________________________________
Kde-frameworks-devel mailing list
Kde-frameworks-devel@kde.org
https://mail.kde.org/mailman/listinfo/kde-frameworks-devel
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic