1024649 - Implement diff picker for updating translations

Status: RESOLVED FIXED

(developer.mozilla.org Graveyard :: Localization, enhancement, P1)

Description

[Florian Scholz (Open Web Docs)]

What problems would this solve?
===============================
Keeping our localized pages up to date is critical. One important feature for updating pages properly, is a diff picker that lets you choose which English revisions you want to compare.

If a localizer saves a page during translation or updating, the diff is no longer shown because the logic assumes that  - with the edit date being more recent - the content is up to date and no diff is needed.

Who would use this?
===================
Localizers who keep pages up to date.

What would users see?
=====================
A modal dialog letting you choose which revisions you want a diff for.

What would users do? What would happen as a result?
===================================================
Localizers would be able to see the diff they need to the keep the page in sync with the English one.

Is there anything else we should know?
======================================
Already noted as a todo in the code :)
{# TODO: 'change revisions' link and modal selector #}

https://github.com/mozilla/kuma/blob/master/apps/wiki/templates/wiki/translate.html#L74

Comment 1

[Florian Scholz (Open Web Docs)]

Attachment: Diff picker on sumo

Comment 2

[Florian Scholz (Open Web Docs)]

fwiw, I'm pretty sure this bug would improve the workflow of many localizers. I encounter this problem myself when trying to keep German articles up to date and then not being able to see the correct diff.

Comment 3

[Jean-Yves Perrier [:teoli]]

I confirm this would help a lot the workflow of our translators.

Comment 4

[Stephanie Hobson [:shobson]]

Most of the UI elements for this already exist in one way or another. Not too much work from a UX or front-end perspective.

Comment 5

[Eric Shepherd [:sheppy]]

It'd be great if any lightbox type of thing this uses is provided as a widget that can be used by other code; we have many things that eventually we'll want presented in lightbox format (likely on-site messaging stuff at times, other diff functions, etc).

Comment 6

[Māris Fogels [:mars] (please needinfo)]

Punted to Luke to help hammer down the specific requirements.

Comment 7

[Luke Crouch [:groovecoder]]

Basically, for :hoosteeno - do we want to copy SUMO's UX for this? That will tell us how to estimate this.

Comment 8

[Stephanie Hobson [:shobson]]

We already have a diff picker on MDN (https://developer.mozilla.org/en-US/docs/Web/XPath/Functions/floor$history), I imagine it would be easier to embed ours in a lightbox with different buttons.

Comment 9

[Justin Crawford [:hoosteeno] [:jcrawford]]

SUMO's interface is satisfactory: We can use it. Let's do an LOE evaluation of this.

Comment 10

[Luke Crouch [:groovecoder]]

We already have an endpoint to get the content diff table between arbitrary revisions of a doc. E.g.:

https://developer.mozilla.org/en-US/docs/User:codegroover$compare?to=643705&from=642397&raw=1
https://developer.mozilla.org/en-US/docs/User:codegroover$compare?to=643705&from=639903&raw=1

(This is how we render the diffs in the revision dashboard)

So, one way to implement this is:

1. User clicks diff-picker link
2. Modal opens with $history view of the English doc
3. User chooses 'from' and 'to' revisions
4. Modal closes, triggers ajax call to $compare?...&raw=1
5. Inject response HTML into the page's diff view container

We would need to:

1. Add UI elements (2 days)
2. A way to open $history view in this "modal mode" (2 days)

Issues:

1. We should remove the title, slug, and comment since those aren't included in the raw compare HTML, so we couldn't update them to the new from revision values. (SUMO doesn't show these either, since translators (I think) are not allowed to edit them anyway?)

So, I say LOE:5 unless we want to preserve title, slug, and comment in the compare viewer. Then I would say LOE:10 because we would have to do either a whole new compare view, or re-write the current one to include those elements.

Comment 11

[David Walsh :davidwalsh]

> "SUMO's interface is satisfactory: We can use it. Let's do an LOE evaluation of this."

Based on our 70/30 discussion, do we want to do better than "satisfactory", where maybe we sketch out exactly what we want, or is this exactly what we want?

Comment 12

[Luke Crouch [:groovecoder]]

:davidwalsh - do you want to sketch out something beyond SUMO's interface before starting?

Comment 13

[David Walsh :davidwalsh]

Not necessarily -- I just wanted to make sure we aren't "settling" for this widget, and it's what we want.  "SUMO's interface is satisfactory: We can use it." sounded hesitant or like "better than nothing".  I want to make sure everyone is giggles about this.  I'll proceed as though people are.

Comment 14

[Luke Crouch [:groovecoder]]

:r1cky - do you have any analytics or metrics on how often the SUMO diff-picker is used? Would like to know what we might expect to see on MDN.

Comment 15

[Māris Fogels [:mars] (please needinfo)]

Dev notes from our call to estimate the amount of work to build this: https://etherpad.mozilla.org/l10n-diff-picker-estimate

Comment 16

[Ricky Rosario [:rrosario, :r1cky]]

Sorry for the late reply. My GA-foo is weak, but the URLs look like this:

https://support.mozilla.org/en-US/kb/<slug>/compare?locale=<locale>&to=<revision_id_1>&from=<revision_id_2>

Maybe Kadir can help?

Comment 17

[Ricky Rosario [:rrosario, :r1cky]]

(In reply to Ricky Rosario [:rrosario, :r1cky] from comment #16)
> https://support.mozilla.org/en-US/kb/<slug>/
> compare?locale=<locale>&to=<revision_id_1>&from=<revision_id_2>

errr.

https://support.mozilla.org/<locale>/kb/<slug>/compare?locale=<locale>&to=<revision_id_1>&from=<revision_id_2>

Comment 18

[Luke Crouch [:groovecoder]]

Wow, okay that looks like a tiny fraction of traffic. 1,302 page-views out of 63,500,000 = 0.00002%.

I'll take that to mean we should expect small usage.

Kadir - how valuable is that comparison diff-picker for SUMO translators?

Comment 19

[Jean-Yves Perrier [:teoli]]

(In reply to Luke Crouch [:groovecoder] from comment #18)
> Wow, okay that looks like a tiny fraction of traffic. 1,302 page-views out
> of 63,500,000 = 0.00002%.

This is not the right way to measure it. As we all editorial toosl, the impact comes from the increase of traffic from extra pages translated (or extra up-to-date translated pages), not the visits of the page.

Comment 20

[Luke Crouch [:groovecoder]]

What if we measure the increase in pages translated with the diff-picker tool?

Comment 21

[Jannis Leidel [:jezdez]]

https://github.com/mozilla/kuma/pull/2876

Comment 22

[MDN Team (:mdn-dev)]

Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/08d3e725cae33974751c7a68009b5a645c418c02
fix bug 1024649 - add ability to change diffed revisions on translation page

https://github.com/mozilla/kuma/commit/dde106141e8204f9e0bcf270aa1bfd390dcfe227
Merge pull request #2876 from jezdez/bug1024649

fix bug 1024649 - add ability to change diffed revisions on translation page