Page MenuHomePhabricator

Interaction Timeline V1: Byte change & minor edit
Closed, ResolvedPublic2 Estimated Story Points

Description

Problem to solve

Users often judge if an edit is worth investigating if it is marked minor and/or based on its byte count. We should display them for the edits in the Timeline


Documentation

Here's some quick documentation for minor edits and byte changes. You can view both byte changes and minor edits on the Donald Duck history page.

Minor edits

Only some edits are marked as minor. Users can optionally mark their own edits as minor if they've made a small change not important enough to be reviewed by another editor. Users can easily lie about making minor edits, so we will just want to display an indication on each edit box.

In existing tools (like page history and Recent Changes) this piece of data is shown with a bold m displaying in the log entry. In this screenshot of three edits, only the middle edit is marked as minor.

Screen Shot 2017-11-14 at 3.48.47 PM.png (76×746 px, 44 KB)

Byte change

There is a byte change to every edit. Byte change is an indication if an edit added/removed a lot/little content. If the user added characters, the byte change is represented in green as (+N). If the user removed characters, the byte change is represented in red as (-N). If the byte change was the same before and after the edit, it is represented as a grey (0). If the byte change is over 500 (either added or removed) the byte change is displayed in bold. This screenshot shows all 5 varieties:

Screen Shot 2017-11-14 at 4.08.06 PM.png (324×601 px, 132 KB)

We do not need to display the total byte count — just the change.


Acceptance criteria

  • If an edit is marked as minor, the 'edit box' on the Timeline should show it
  • The byte change for every edit (positive, negative, neutral) should be shown in every edit card
  • The new data should match the placement and color style of the wireframe, below

Wireframe

Screen Shot 2017-12-01 at 3.25.36 PM.png (943×1 px, 235 KB)

Event Timeline

TBolliger added a subscriber: dmaza.

@dbarratt @dmaza @CSindersWMF @SPoore @DannyH — I've mocked up a potential place to put the byte change and minor edit indicators. Thoughts?

Screen Shot 2017-12-01 at 3.25.36 PM.png (943×1 px, 235 KB)

Byte change uses the same color/bold logic from article history and recent changes:

  • If the user added characters, the byte change is represented in green as (+N).
  • If the user removed characters, the byte change is represented in red as (-N).
  • If the byte change was the same before and after the edit, it is represented as a grey (0).
  • If the byte change is over 500 (either added or removed) the byte change is displayed in bold.

I think it looks fine. Most users using this tool are familiar with this "syntax" so they will know what it means.

I think so. It needs to stand out from the edit summary and it is consistent with what we do on the wikis

Any other comments on my proposed placement of byte change and minor edits?

I think the colors clash a little... what do you think @CSindersWMF?

I agree that we can probably find more complimentary colors, as long as they're shades of green and red. @CSindersWMF — what resource did you use to select those two column colors?

TBolliger changed the task status from Open to Stalled.Jan 16 2018, 8:04 PM
TBolliger moved this task from Triage/To be Estimated to Analytics on the Anti-Harassment board.
TBolliger set the point value for this task to 2.

Blocked by T184146: Sub-epic ⚡️ : Create an API service for InteractionTimeline.

Sized based on how this will be built after the API exists.

TBolliger changed the task status from Stalled to Open.Feb 1 2018, 9:27 PM
dbarratt removed dbarratt as the assignee of this task.
dbarratt moved this task from Ready to In progress on the Anti-Harassment (AHT Sprint 15) board.

Can we add a space between the m and the ( ?

Otherwise it looks great!

The initial mock has colors on the bytes.. are we not doing that anymore? m is also bold

Can we add a space between the m and the ( ?

Otherwise it looks great!

Done.

  • The initial mock has colors on the bytes.. are we not doing that anymore? m is also bold

    The colors clash.... but I'll remove the bold.

    I'm of two minds about the red/green color for -/+ diffs... I agree with David that they do agree with the blue/green cards.

    For now, let's leave them black text. We can easily add them later.

    The m should be bold. If the byte change is over 500 (either + or -) the byte change should also be displayed in bold.

    I'm of two minds about the red/green color for -/+ diffs... I agree with David that they do agree with the blue/green cards.

    For now, let's leave them black text. We can easily add them later.

    The m should be bold. If the byte change is over 500 (either + or -) the byte change should also be displayed in bold.

    Done.

  • @TBolliger wait... it should only be bold if it's over 500 AND a minor edit? or just over/under 500?

    The m is always bold.

    The byte amount — independent of minor/not — is bold only if over +/-500

    This appears to be correct in the screenshot above. ship it!