Page MenuHomePhabricator

Clean up / improve Gadget tutorial related pages on mediawiki.org
Closed, ResolvedPublic

Description

This feels related to T242545 and probably takes me enough time to welcome a dedicated task.

Also note that https://commons.wikimedia.org/wiki/File:Userscript_and_Gadgets_workshop_toolkit.pdf is a good tutorial resource by @srishakatux but currently not linked anywhere.

Event Timeline

Aklapper triaged this task as Medium priority.Feb 18 2020, 9:44 AM
Aklapper created this task.
Aklapper updated the task description. (Show Details)
Aklapper added a subscriber: srishakatux.

Done already:

I always underestimate how long things take. Mostly done.

Left:

Left:

I guess for these two bullet points I'd love to have input from @srishakatux.
Looking at pages 20 and 21 I cannot copy that code (because images) and I'm not sure what that code does. (And if we should add it to the wiki page.)

@Aklapper The tutorial looks really nice! :) I've minor comments:

  • I am not sure what siteJS in this line means and is bolded “For completeness: Interface administrators can also add and edit the siteJS”
  • The QuickRC.js example is a good example of a complex user script and you can ignore the OOUI & API example in the workshop slides. I think it still might be worth running the QuickRC.js script to ensure that it works as it was written a long time ago, and things might have changed ;-)
  • About adding the high-level examples as in the workshop slides, I don't have strong opinions. Maybe when we have the recommendation list ready for Gadgets, we can simply point to that?
  • It might be helpful to share probably in the "Related pages" section, link to some EventLogging pages and say that one can consider using that mechanism for storing data. I couldn't find any relevant links that talk about EventLogging + Gadget. I wrote a blog post once that touches on this a bit but is not entirely focused on EventLogging https://medium.com/@Srish_Aka_Tux/documentation-feedback-gadget-for-wikis-c280531e3108.
  • There is no one in the IRC channel #mediawiki-gadgetkitchen other than me :-( Or, I am in the wrong channel myself. Maybe double check? If it is still the case, we should not link that and wait till we finalize on where to direct SWT related queries. This should still be the best place till we decide : https://meta.wikimedia.org/wiki/Tech

Thanks @srishakatux!

  • I am not sure what siteJS in this line means and is bolded “For completeness: Interface administrators can also add and edit the siteJS”

I have moved the explanation "The JavaScript in that file affects everyone and is executed automatically for both logged-out and logged-in users." to the front. Not sure how else to explain it.

  • The QuickRC.js example is a good example of a complex user script and you can ignore the OOUI & API example in the workshop slides. I think it still might be worth running the QuickRC.js script to ensure that it works as it was written a long time ago, and things might have changed ;-)

I tried it and it works. :)

  • About adding the high-level examples as in the workshop slides, I don't have strong opinions. Maybe when we have the recommendation list ready for Gadgets, we can simply point to that?

Sounds good. Added to T246181.

  • It might be helpful to share probably in the "Related pages" section, link to some EventLogging pages and say that one can consider using that mechanism for storing data. I couldn't find any relevant links that talk about EventLogging + Gadget. I wrote a blog post once that touches on this a bit but is not entirely focused on EventLogging https://medium.com/@Srish_Aka_Tux/documentation-feedback-gadget-for-wikis-c280531e3108.

https://www.mediawiki.org/w/index.php?title=Gadget_kitchen&type=revision&diff=3717083&oldid=3717082

  • There is no one in the IRC channel #mediawiki-gadgetkitchen other than me :-( Or, I am in the wrong channel myself. Maybe double check? If it is still the case, we should not link that and wait till we finalize on where to direct SWT related queries. This should still be the best place till we decide : https://meta.wikimedia.org/wiki/Tech

Right, good catch. I removed it. Cannot find it under https://meta.wikimedia.org/wiki/IRC/Channels either. No other mentions on meta or mediawiki.org either. Guess it was wishful thinking in 2012 or earlier to establish that channel.