998346 - Rebuild the English source document's JSON when translating

Status: VERIFIED FIXED

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

Description

[Florian Scholz (Open Web Docs)]

What feature should be changed? Please provide the URL of the feature if possible.
==================================================================================
STR

1) Translate or update https://developer.mozilla.org/de/docs/Mozilla/Firefox_OS/Benutzung_des_App_Managers

2) Have a look at the doc's JSON: https://developer.mozilla.org/de/docs/Mozilla/Firefox_OS/Benutzung_des_App_Managers$json
Notice the last_edit field: 2014-04-18T07:06:41

3) Look at the English source doc's JSON:
https://developer.mozilla.org/en-US/Firefox_OS/Using_the_App_Manager$json
Notice the last_edit field: 2013-10-20T07:00:05

So, the English doc is not rebuilt and no current data is provided there unless you force-refresh the English page.

I am proposing to rebuild the English page as well, when you save a translated version of it to have this data up to date automatically.

What problems would this solve?
===============================
The doc status page https://developer.mozilla.org/de/docs/MDN/Doc_status/Firefox_OS gets the JSON of the English tree and does not get recent data when translators translated a document. So would have to force-refresh the English source document of the page they have translated.



Who would use this?
===================
Several localizers we engaged to use documentation status pages have noticed this, as they did some work and weren't able to get a "green bar feeling" right after refreshing the doc status page because of this.

What would users see?
=====================
Up to date doc status pages.

What would users do? What would happen as a result?
===================================================
Happier localizers, more MDN page translations.

Is there anything else we should know?
======================================
I am happy to answer any questions and to drive this. I would love to see this fixed in the very near future. I will have a look at the code, if I find something to fix this.

Comment 1

[Florian Scholz (Open Web Docs)]

Les, what do you think about this? 

I would say it is also a nice side effect to have English docs regenerated more often if we would rebuild them once someone touches a translation. Would love to hear some feedback about this idea and how difficult it would be to implement this.

(note that in step 3) in the above description, the wrong last_edit field is under "translations" in the JSON of the English doc of course.)

Comment 2

[Les Orchard [:lorchard]]

Seems not too hard. We should get this bug prioritized, however that process works these days :)

Comment 3

[Luke Crouch [:groovecoder]]

:lorchard - can you extrapolate "not too hard" into an estimate of N day(s), N week(s), or N month(s) so we can prioritize appropriately as a small bug or a big project?

Comment 4

[Les Orchard [:lorchard]]

(In reply to Luke Crouch [:groovecoder] from comment #3)
> :lorchard - can you extrapolate "not too hard" into an estimate of N day(s),
> N week(s), or N month(s) so we can prioritize appropriately as a small bug
> or a big project?

Not sure, maybe 1 week? This is probably just a few lines to trigger a re-render, plus some tests to ensure it worked.

Comment 5

[Luke Crouch [:groovecoder]]

Since it's more than just a day, I added this to our engineering roadmap under the "Proposed" column:

https://trello.com/c/PdtLclEc/38-rebuild-english-json-when-translating

We will prioritize it alongside the rest.

Comment 6

[ali spivak]

This bug is currently causing a major impediment/block to our localization efforts and localization community recruitment. 

Mars - what is the most effective way to indicate this is a high-priority business blocker for the content/community team?

Comment 7

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

Discussed on IRC: everything looks in order, this is already P1 and listed on https://etherpad.mozilla.org/mdn-projects.  I've moved this to the top of our Most Wanted list (it was #2).

Given the urgency, I also asked the dev team to look into it.  Someone should pick up this bug soon.

Comment 8

[[github robot]]

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

https://github.com/mozilla/kuma/commit/6a78c05050aac71d59a4d9e27441e644fc32cbb1
Fix bug 998346: Rebuild source document JSON on translate.

This is slightly hacky and ends up duplicating code, but the way the
rendering and JSON building happens currently there seems not to be
another option to force-refresh the parent doc's JSON.

https://github.com/mozilla/kuma/commit/4644b4c27211ff6bb17f8795b85574ed6dee1f95
Merge pull request #2444 from ubernostrum/translation-json-998346

Fix bug 998346: Rebuild source document JSON on translate.

Comment 9

[Florian Scholz (Open Web Docs)]

James, thanks a lot! This is really awesome!

I just tested this. You can now translate a doc and when you refresh the doc status pages (which refresh themselves everyday, too), you can see the real up-to-date status of the listed pages. This is fantastic and makes the doc status pages work for our localizers plus it rebuilds even more articles, which is also good.

Thanks again for fixing this! A huge win.

Comment 10

[Jean-Yves Perrier [:teoli]]

I approve: James this is really awesome!