951617 - Completely exclude How to Contribute articles from KB dashboard metrics

Status: RESOLVED FIXED

(support.mozilla.org :: Knowledge Base Software, task, P2)

Description

[Ton [:Tonnes]]

After bug 904036 was fixed, it appears that the total number of articles to localize now suffer from another bug where

- How to Contribute articles that still have been localized are added to the total number of localized articles and now counted in the score while they should be ignored, and
- How to Contribute articles that have _not_ been localized are distracted from the total of articles to localize, as if they now should be localized. *

* The second problem appears to occur just since a few days after recent changes to the code, i.e. as if an earlier fix has been undone. (Prior to that, one could gain and get to 100% by localizing HTC articles while the rest wasn’t up to date.)

For reasons described in bug 904036, How to Contribute articles should not be counted or even shown on the KB dashboard. Keeping in mind that (as with any other tool) the dashboard is intended to display the score of _end user_ articles to localize (so to see the _real_ workload for localizers), it is fine to localize those of course, but they should never trigger any localizer as if there is something not up to date, nor should they result in causing any score to get above 100%, as they now do in the aggregated metrics for instance (!), or until recently (prior to the second issue) by displaying a number of e.g. 103% on the KB dashboard itself (All KB articles, 2nd bar, currently also visible on the Thunderbird Sumomo dashboard for e.g. the pl locale). Basically, How to Contribute articles should use a different l10n mechanism outside the dashboard ‘score engine’, but that would take a lot of work, I suppose.

Over IRC Kadir told me that points of view on whether or not to include them in scores may have changed due to local forums that now exist, but 1) I don’t think the forum aspect has anything to do with either displaying false workload or including those articles as a ‘must have’ and 2) if the only way to work around this for locales not translating them is copying over en-US articles to local ones on a regular basis when localizers do not want to ‘get false alarms’ (e.g. when the Contributor News and Resources article has been updated again), this is merely a bad workaround that should still be applied every now and then, not reducing the workload and keeping the false alarms. Also, including them from now would make the work in bug 904036 useless.

Please put HTC articles in/on a separate list/spot (e.g. as with products, while they don’t get counted), create something like an Ignore button (Kadir came up with that) or (easier) just exclude them from _any_ metrics/rates/scores globally while still enabling them to get localized if teams want to.

Comment 1

[Ricky Rosario [:rrosario, :r1cky]]

Do we just want to discount those articles in the % Localized metric? Can we still list them in the full list (https://support.mozilla.org/es/localization/most-visited-translations)?

Comment 2

[Rosana Ardila]

Ton,

I agree that it makes sense to keep the "How to contribute" articles in a different category and not display them. But I think we need to be careful, because this articles should be displayed somewhere for contributors to translate. Many locales would benefit very much from having translated "How to contribute" information (specially the ones building new forums).

I will discuss with Ricky and Kadir how we can solve this.

Thanks!

- Rosana

Comment 3

[Ton [:Tonnes]]

Rosana, please keep in mind that displaying them in some list is not the actual problem - they should just not be included in any _metrics_ (which was OK until recently) nor possibly even cause email notifications. An l10n dashboard concerns end user articles - these How to Contribute articles are just instructions that happened to be shaped as Sumo articles, hence offering the ability to localize them, but in fact are completely different and should not lead to false workload or other confusion.

Comment 4

[Rosana Ardila]

Agree! I'll talk to Kadir and Ricky to figure out a solution. Thanks Tonnes!

Comment 5

[Ricky Rosario [:rrosario, :r1cky]]

Fixing this is just a matter of reverting part of https://github.com/mozilla/kitsune/commit/cb45acd246040a7bd18dc72ad9cf8e00ef4f76a0

Comment 6

[Kadir Topal [:atopal]]

We need some time to talk about this before we put it into the sprint.

Comment 7

[Kadir Topal [:atopal]]

Didn't have time to talk about this during the last cycle, moving forward.

Comment 8

[Ton [:Tonnes]]

Too bad, considering this is some form of regression…

Comment 9

[Ricky Rosario [:rrosario, :r1cky]]

see bug 951783 comment 3

Comment 10

[Ricky Rosario [:rrosario, :r1cky]]

(In reply to Ricky Rosario [:rrosario, :r1cky] from comment #9)
> see bug 951783 comment 3

GAH! Sorry. wrong bug. this goes in bug 937184

Comment 11

[Ricky Rosario [:rrosario, :r1cky]]

pushing along during sprint planning

Comment 12

[Ricky Rosario [:rrosario, :r1cky]]

Still waiting on comment 4, comment 6, comment 7, ....

Comment 13

[Rosana Ardila]

Ricky,

thanks for the reminder and sorry for dropping the ball here.

I think that it makes sense to not count this articles for the stats, but we should surface them nevertheless. And since they probably get less visits than the support articles they will go down on the new dashboard :)

Is it possible to just show them on the dashboard while not counting them? We should probably document this on the documentation about L10n, so that new contributors know that these articles exist and can find them.

How does this sound?

Thanks,

- Rosana

Comment 14

[Ricky Rosario [:rrosario, :r1cky]]

(In reply to Rosana Ardila from comment #13)
> I think that it makes sense to not count this articles for the stats, but we
> should surface them nevertheless. And since they probably get less visits
> than the support articles they will go down on the new dashboard :)
> 
> Is it possible to just show them on the dashboard while not counting them?

Yep, we can do this. We'll exclude the articles when it comes to the progress bars in the overview section, but we'll include the articles in the list below sorted by visits.

Comment 15

[Rosana Ardila]

Cool! let's go for that :)

Comment 16

[Kadir Topal [:atopal]]

Now I'm unsure if you really meant 2014.8, Ricky ;)

Comment 17

[Will Kahn-Greene [:willkg] ET needinfo? me]

We pushed this off to next quarter so we're not snowballing bugs sprint to sprint.

Comment 18

[Ricky Rosario [:rrosario, :r1cky]]

Q1 is over. Bring it on, Q2!

Comment 19

[Ricky Rosario [:rrosario, :r1cky]]

Deployed to prod.

https://github.com/mozilla/kitsune/commit/cf9965186899f32b2c142b93b97daf0aad1b759e

Comment 20

[Kadir Topal [:atopal]]

This might have caused a regression. We are showing 110% localization coverage here: https://support.mozilla.org/fr/localization?product=mobile

I'm not sure if it's related, but this was the only change to the dashboard recently as far as I can tell.