Description
Lua documentation that we currently have on meta-wiki & mediawiki.org needs some improvements. It is not explained clearly in the docs what Lua is, what it is used for, how it is connected with wiki modules, the different use cases it helps serve on wikis, etc. The three main resources around Lua that need work as part of this task are:
- https://www.mediawiki.org/wiki/Lua. Thoughts: It does not explain what and why for Lua, and some content from http://mediawiki.org/wiki/Lua_scripting (WMF specific project running from 2011 to 2013) currently marked as obsolete, could be copied/moved.
- http://mediawiki.org/wiki/Lua_scripting
- https://www.mediawiki.org/wiki/Lua/Tutorial. Thoughts:
- This tutorial was written in 2012 for a Hackathon, and since then has not been updated much. In its current state, it is incomplete and confusing.
- It could benefit from some material from the top "Introduction" section of https://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual
- It could act as a short tutorial. It should link to the API reference at https://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual
- There is a wonderful collection of tasks detailed here: https://en.wikipedia.org/wiki/User:RexxS/GCI that show how to perform certain functions in Lua, which could be used. But wondering how much "new to templates" vs. "used to templates but not the Lua way" audience differentiation is needed.
Note: An additional review to understand what these resources are lacking, what can be added there might be helpful before kicking off the improvements.
See also
Some linked resources on en.wp (see below) are useful and verbose. To "properly" import some content while still giving credits to its authors, you can either use https://www.mediawiki.org/wiki/Special:Import (the drop-down menu includes enwiki) or use an edit-summary like "copying content from [[w:en:Module:....]], see which for attribution".
- https://en.wikipedia.org/wiki/Wikipedia:Lua
- https://en.wikipedia.org/wiki/Help:Lua
- https://en.wikipedia.org/wiki/Help:Lua_debugging
- https://en.wikipedia.org/wiki/Help:Lua_for_beginners
- https://en.wikipedia.org/wiki/Wikipedia:Lua/Resources
- https://en.wikipedia.org/wiki/Wikipedia:Guide_to_Scribbling
- https://en.wikipedia.org/wiki/Wikipedia:Comparable_Lua_functions_to_wikitext
- https://en.wikibooks.org/wiki/Lua_Programming
Mentors
Skills required
On-wiki editing, familiarity with a scripting language would be nice to have but not necessary.
Microtasks
Documentation-related (Documentation), good first tasks (good first task) that require on-wiki changes and are linked from this section: https://www.mediawiki.org/wiki/Good_first_bugs#Documentation