Page MenuHomePhabricator

LintErrors should have a manual at the top of the report pages
Open, LowPublic

Description

to have effective cooperation it is much better to have a simple manual to show users what they should do to solve the errors like the text at the top of here

The article has an arrow like "<--" or "-->" or "<==" or "==>". Write better this arrow with the Unicode "←" or "→" or "⇐" or "⇒". See Arrow (symbol). If it is sourcecode then use <source> or <code>. Also you can use <math> for mathematical formula. 
Following tools can correct or warn of the problem:

Event Timeline

it is much better to use helps like this at https://translatewiki.net which users can translate it to their own language without switching to another website like www.mediawiki.org
Instead of Special:LintErrors, it should be at the top of each suberror like this

You might join a particular page on German Wikipedia and grasp for the lifebelt.

Every linter subcategory has a "Help" link in the top right corner that goes to mediawiki.org. I am hesitant to put a lot text in the extension's i18n messages as it is less accessible to improve compared to a wiki page. Do we need to make the mediawiki.org link more prominent? Or should we regularly just copy what's written on mediawiki.org into the extension?

I agree with making the mediawiki.org link more prominent - maybe place it at the beginning of the description line? Maybe change the text from "Help" to "More help on how to fix these" ?

I agree that it's a lot easier for us to collaborate on improving the wiki-page documentation, than it is for us to discuss edits to the en.json file. (The main page and sub-pages are now all marked for translation, too).

However, I agree that we could also improve the contents of the en.json file (and thus translations), but we need specific suggestions. I've thrown the current strings on a page at https://www.mediawiki.org/wiki/Help:Extension:Linter/inline_documentation_discussion - please add suggested improvements there, or suggest something else!

There was feedback on en.WP about how the help link is not prominent at all (ref permalink to VPPRO). I've had to re-discover the link at least once before.

Should the prominence of that link be a separate task? (Probably not, but I don't think it's unreasonable to ask.)

MediaWiki:Linterrors-summary looks as though it can be populated to include whatever you want

Even the help link is customizable on wiki from MediaWiki:helppage-top-gethelp

@Yamaha5 I'm not seeing a lot of changes needed in software here; the text and link targets can already be updated - is there something else needed?

Even the help link is customizable on wiki from MediaWiki:helppage-top-gethelp

@Yamaha5 I'm not seeing a lot of changes needed in software here; the text and link targets can already be updated - is there something else needed?

Well, the Lint fixes are needed on a lot of wikis, and it is highly unlikely that we can get sysops (or stewards, for the matter) create multiple MW messages on each of them. A centralized solution, that also allowed localization, would be a better solution.

@Elitre isn't that what we already have - there are messages assigned to these pages already, just make translations.