Page MenuHomePhabricator

Review and improve Lua documentation on meta and mediawiki.
Closed, ResolvedPublic

Description

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:

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".

Mentors

@RexxS, @Pavithraes

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

Event Timeline

Aklapper updated the task description. (Show Details)
Aklapper updated the task description. (Show Details)
Aklapper updated the task description. (Show Details)

Regarding pages on meta and mediawiki.org: We should be in an okay'ish state now, except for

Some linked resources on en.wp are good and verbose; wondering how to "properly" import some content while still giving credits to its authors.

@srishakatux was wondering if we should consider promoting this task via Outreachy. I think it could be, if the person working on this already has a little bit of on-wiki Lua knowledge, and after checking if RexxS would also be in to reuse the GCI tasks linked above. However, would probably also need a mentor who knows Lua?

Heh, thanks! (Could have also CC'ed here.) :)

Hi folks - sure, I'd be glad to help out, of course. All the materials I used for GCI are available under CC-BY-SA anyway from [[:en:User:RexxS/GCI]] but I can release them as CC-0 if that's easier for anybody to use.

I'm happy to work with an intern to on the project, and if they need bringing up to speed on Scribunto, I can help with as well.

@RexxS Thank you so much for willing to be a mentor on the project! I will share some ideas towards the end of this week on scoping this project and some next steps.

I also wonder if some [parts] of the quite good Lua docs on en.wp could be imported to mw.org, but I'm clueless when it comes to properly giving credits.
Wondering if @Quiddity might have any hints / recommendations to share? Importing some revisions (somehow), as crosswiki transclusion doesn't exist AFAIK?

@Aklapper 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"

I've modified the task description a bit and adjusted it via the Outreach-Programs-Projects project description template. Also, promoted this project in a few documentation streams in our Zulip chat, asking if anyone might be interested in being a co-mentor on the project with RexxS.

Aklapper updated the task description. (Show Details)

@RexxS Hi! I am a past Season of Docs participant with Wikimedia. I can help out in a secondary role with this project, but might not be able to make a full commitment. If that's ok, I'd be happy to co-mentor this project. :)

@RexxS Thanks for your interest and willingness! Considering that you are a Lua expert, I have been searching for someone with a tech writing background. I had a chat with @Pavithraes, and she says that she can help in a supporting role, but cannot commit to this full time. She is willing to support the applicants during the contribution phase between October and November. During the three-month-long internship period, she can occasionally help review an intern's work between December to February and give feedback on the documentation. So, while I am still looking for someone who can commit to co-mentoring full time with you (which means on an average 3-5 hrs per week for three months) in the meantime, I also wanted to ask you:

  • To go through these guidelines to learn about the roles and responsibilities of a mentor: https://www.mediawiki.org/wiki/Outreachy/Mentors and be aware of what you are signing up for :)
  • Would it be possible for you to allocate 3-5 hrs per week with an intern between December-February? If it is too much work, you can frankly tell us.

If you can do so before Friday, we will have better clarity if it would still be a good idea to promote this project in the upcoming round.

@srishakatux thanks for contacting @Pavithraes - I'm sure she'll be an excellent co-mentor and her skills in technical writing will be invaluable. I understand that it's hard to commit to full-time support for the intern, but I'm sure that whatever time she can give will be greatly appreciated.

I've looked through the linked page and the three linked pages on the Outreachy site (!) and it all seems quite reasonable. I'm used to devoting an hour or so a day to the Google-Code-In over the winter, so the time commitment won't be a problem, especially as I've been retired for several years now. I've got over 30 years of experience teaching and lecturing, so mentoring an intern shouldn't present any problems. I also had over 10 years as an IT Manager, so I'm quite comfortable with staff appointment procedures and induction.

What would be helpful would be a draft time-line for the full process as you see it, and naturally I'd appreciate any guidance from experienced Outreachy mentors as I work through my first attempt at the role.

@RexxS Thank you, all that sounds good to me and promising :) The program timeline is here: https://www.mediawiki.org/wiki/Outreachy/Round_21#Program_timeline.

I've created a project proposal on the Outreachy site that you and @Pavithraes can sign-up to co-mentor for:
https://www.outreachy.org/outreachy-december-2020-internship-round/communities/wikimedia/review-and-improve-lua-documentation-on-meta-and-m/cfp/. You might be asked to provide a few details. And the deadline to do this is Saturday, October 3rd, at 16:00 UTC.

I would be happy to answer any questions you might have during the program and can connect you with experienced mentors for specific questions. I just realized that in the upcoming round, we would have a few folks for whom it will be there first time mentoring in Outreachy, so let me think about a plan for how to support you all better :)

srishakatux raised the priority of this task from Low to Medium.Oct 1 2020, 7:33 AM

@srishakatux @RexxS Thank you! I've signed-up on the Outreachy website. Looking forward to a wonderful Outreachy! ^>^

@RexxS I've created a topic for this project on Wikimedia's Zulip here: https://wikimedia.zulipchat.com/#narrow/stream/outreachy21/topic/Lua.20documentation

Would Zulip work for you as a communication channel? We can discuss and update if you prefer a different platform. :)

Zulip's okay: not my favourite, but I'm used to using it from Google Code-In.

Hi I am Udokaku Ugochukwu, an outreachy participant, I love to contribute to the lua documentation project, I'd would also need a guide this is would be my first using lua

Pavithraes added a subscriber: Hanan8822.

I'm boldly assigning this to a mentor, so contributors won't claim this before Outreachy.

@Aklapper Thanks!

@Udoka_Ugo Welcome! Please see the Microtasks section in the project description to get started. :)

Is everything in this project task planned for Outreachy (Round 21) completed? If yes, please consider closing this and other related tasks as resolved. If bits and pieces are remaining, you could consider creating a new task and moving them there.