716260 - [SuMoMo] Show creator's descriptive comment in Revision Information when viewing a Wiki article revision, and for "Compare revisions"

Status: RESOLVED WONTFIX

(support.mozillamessaging.com Graveyard :: General, defect)

Description

[Thomas D. (:thomas8)]

+++ This bug was initially created as a clone of Bug #716254 +++

STR
1) view a revision of a Wiki article like (1), e.g. revision (2)
2) Look for creator's comment in the "Revision Information" section at the top
3) For comparison, check out usage and importance of creators' comments on the articles history view (3)

Actual Result
2) creator's descriptive revision comment is missing from "Revision Information"

Expected Result
2) creator's descriptive revision comment should be included in "Revision Information" (probably as "Creator's Comment:" below "Creator:"), because it gives important information on that particular revision

Next steps:

Is this bug in the right product and component?
Who, if anybody, needs to ui-review this change?
Whom can we CC to edit the respective template/wiki code?

This should be easy to do (about 5 mins), as the requested comment entry is structurally the same as neighbouring entries in that section.

(1) https://support.mozillamessaging.com/en-US/kb/keyboard-shortcuts
(2) https://support.mozillamessaging.com/en-US/kb/keyboard-shortcuts/revision/5396
(3) https://support.mozillamessaging.com/en-US/kb/keyboard-shortcuts/history

Comment 1

[Thomas D. (:thomas8)]

Same applies to the "Compare Revisions" view (4), where showing creators' comments would be even more helpful to keep the purpose/intentions of the revision in sight while reviewing.

STR
1) Compare 2 revisions of wiki article to review the changes ("Compare Revisions"), e.g. (4)
2) Look for creator's comment what he did and why in the new revision

Actual Result
2) Valuable information about the revision is missing while comparing/reviewing

Expected Result
2) Make creator's comment of both revisions available for the reviewer

Possible Implementations:

a) add comment as plaintext below revision header, where we currently show:
> Revision 5396 by ThomasD on December 28, 2011 2:45:35 PM PST;
So this could become
> Revision 5396 by ThomasD on December 28, 2011 2:45:35 PM PST; Comment: "Fix
> wrong, misleading entries; remove outdated and duplicate-within-section
> entries; reorder some entries. Pls double-check revised entries for
> non-windows platforms."

b) Hide comment behind an iconic or linkified toggle, e.g.
> Revision 5396 by ThomasD on December 28, 2011 2:45:35 PM PST; (_comment_)
Then, either
- clicking on toggle reveals comment within document, similar to a)
- clicking toggle shows tooltip/floating div with comment
- hovering toggle text or icon shows tooltip/floating div with comment

(4) https://support.mozillamessaging.com/en-US/kb/keyboard-shortcuts/compare?locale=en-US&to=5396&from=5138

Comment 2

[Roland Tanglao needinfo please :rolandtanglao, :mohnkuchen, :adobo, :sinigang, :roland]

(In reply to Thomas D. from comment #0)
> +++ This bug was initially created as a clone of Bug #716254 +++
> 
> STR
> 1) view a revision of a Wiki article like (1), e.g. revision (2)
> 2) Look for creator's comment in the "Revision Information" section at the
> top
> 3) For comparison, check out usage and importance of creators' comments on
> the articles history view (3)
> 
> Actual Result
> 2) creator's descriptive revision comment is missing from "Revision
> Information"
> 
> Expected Result
> 2) creator's descriptive revision comment should be included in "Revision
> Information" (probably as "Creator's Comment:" below "Creator:"), because it
> gives important information on that particular revision
> 
> Next steps:
> 
> Is this bug in the right product and component?
> Who, if anybody, needs to ui-review this change?
> Whom can we CC to edit the respective template/wiki code?
> 
> This should be easy to do (about 5 mins), as the requested comment entry is
> structurally the same as neighbouring entries in that section.

As a technical person Thomas I am sure you know that using "should" or "about 5 mins" is a recipe for endless yak shaving :-)

Anyhow in case you don't know the code is here:
https://github.com/jsocol/kitsune/

Please check it out. Pull requests welcome :-) I wouldn't be surprised if this is fixed in future versions of Kitsune (SuMoMo is running Kitsune from September 2011, Firefox support aka "SUMO" updates Kitsune every 2 weeks so it's very possible this is already fixed, please check it out at support.mozilla.org if you have time to see it's already fixed)

And the approvers are jsocol for kitsune and for SuMoMo's kitsune instance :sancus. Don't know who has Kitsune UX approval but jsocol would know.