Page MenuHomePhabricator

Outreachy 2020-2021 Proposal Review and improve Lua documentation on Meta and Media Wiki.
Closed, DeclinedPublic

Description

Jude Ukana
@JukanaCodes
Judeukana@gmail.com
Location Nigeria

SYNOPSIS


MediaWiki is the software that powers Wikipedia, meta, media wiki and several other wikis world over.
MediaWiki’s documentation serves as valuable tool for developers and it’s users who rely on contributors to update and improve related documentations.
This project however focuses on Lua documentation. The current Lua documentation on Media wiki does not properly explain what Lua is and how it is linked to and from other Wiki’s.
This proposal is about improving and updating the current Lua documentation.
Especially looking at these 3 resources to review and update ;

These will be done by making edits on already existing MediaWiki pages and creating new ones where necessary.

IMPLEMENTATION METHOD


1.Review and understand what is lacking in the current LUA resources.

  1. Research Lua and related Api’s
  2. Update incomplete LUA tutorials document

WHY IS THIS NECESSARY


Improving Lua documentation will provide educational information to not only MediaWiki users and developers but a large number of people interested in Lua world over.

About Me


I have a Bsc Hons in Computer science from Kwame Nkrumah University of Science and Technology Ghana.
I got introduced to FOSS and opensource when I attended the Open source Africa conference in Lagos in February this year. I learnt that I can not only be a consumer of software projects but that I can also contribute to Free and open source software projects which have helped shape the modern world.

I attended the OSCA opensource festival 2020 in Lagos + Sustain Conference in Nigeria. I am involved in Google Developers Group Lagos. I specialise in back end programming with competency in scripting languages such as Java and JavaScript.

DELIVERABLES

Period Task
DEC 1- DEC 4 community bonding • Get to know more about the community and its members •
DEC 7 - DEC 11 Clean up my blog and make it ready to accept posts •Create designs of how the finished implementation would look • Share the designs with the mentors and get feedback
DEC 14 - DEC 18 Start Working on the Phabricator task
DEC 21 - DEC 25 Begin Research on Lua and work with more experienced Mentors with knowledge of Lua language
DEC 28 - JAN 1 Begin Editing the Lua documentation on one of the 3 that need rework https://www.mediawiki.org/wiki/Lua • Post the topic for the week on my blog
JAN 4- JAN 8 Post the topic for the week on my blog
JAN 11 - JAN 15 Feedback and wrap up of work done on https://www.mediawiki.org/wiki/Lua
JAN 18 - JAN 22 Post the topic for the week on my blog
JAN 25 - JAN 29 Start Working on the second Lua resource http://mediawiki.org/wiki/Lua_scripting.
FEB 1 - FEB 5 Receive feed back from mentor and Post the topic for the week on my blog
FEB 8 - FEB 12 Work on the last Lua Resource https://www.mediawiki.org/wiki/Lua/Tutorial and maintain linking of Lua resources to and from other wikis. Show what has been done so far to mentor for review.
FEB 15 - FEB 19 Feedback and wrap up the Phabricator task
FEB 22- FEB 26 Start working on adding new pages for Lua resources on Meta and wiki media where neccessary.
FEB 26- MAR 2 Feedback and wrap up the Phabricator task

Event Timeline

@JukanaCodes Thanks for the proposal! I like that you've included blog posts in your timeline. :) Overall, I think the timeline can be slightly more detialed, but it'll work as is too. Some suggestions:

"DEC 14 - DEC 18 Start Working on the Phabricator task"

Instead of "Phabricator task" you can say "Outreachy project", or link to the mentioned task because there are many tasks on Phabricator. You can also add details about where you would start. For example, you've mentioned research in the following week, which is a good starting point.

"FEB 22- FEB 26 Start working on adding new pages for Lua resources on Meta and wiki media where necessary.

I understand meta refers to https://meta.wikimedia.org. I'm not sure I understand "wiki media", it'll be helpful if you could clarify if you mean https://www.mediawiki.org or any other space. I also suggest you add details about what kind of new pages you have in mind, if you're not sure, you can leave it as is.

FEB 15 - FEB 19 Feedback and wrap up the Phabricator task
FEB 26- MAR 2 Feedback and wrap up the Phabricator task

Again, I suggest rephrasing "Phabricator task". I also wanted to confirm if you meant to have the same task for both these weeks.

All the best!

@JukanaCodes Thanks for the proposal! I like that you've included blog posts in your timeline. :) Overall, I think the timeline can be slightly more detialed, but it'll work as is too. Some suggestions:

"DEC 14 - DEC 18 Start Working on the Phabricator task"

Instead of "Phabricator task" you can say "Outreachy project", or link to the mentioned task because there are many tasks on Phabricator. You can also add details about where you would start. For example, you've mentioned research in the following week, which is a good starting point.

"FEB 22- FEB 26 Start working on adding new pages for Lua resources on Meta and wiki media where necessary.

I understand meta refers to https://meta.wikimedia.org. I'm not sure I understand "wiki media", it'll be helpful if you could clarify if you mean https://www.mediawiki.org or any other space. I also suggest you add details about what kind of new pages you have in mind, if you're not sure, you can leave it as is.

FEB 15 - FEB 19 Feedback and wrap up the Phabricator task
FEB 26- MAR 2 Feedback and wrap up the Phabricator task

Again, I suggest rephrasing "Phabricator task". I also wanted to confirm if you meant to have the same task for both these weeks.

All the best!

oh great! Thanks so much @Pavithraes :). I'll make amendments Asap. also I already submitted my final application tho and I didn't include all that I have here in this proposal. is that going to be a problem?

Gopavasanth subscribed.

@JukanaCodes We are sorry to say that we could not allocate a slot for you this time. Please do not consider the rejection to be an assessment of your proposal. We received over 28 quality applications, and we could only accept 7 interns. We were not able to give all applicants a slot that would have deserved one, and these were some very tough decisions to make. Please know that you are still a valued member of our community and we by no means want to exclude you. Many interns who we did not accept in 2019 have become Wikimedia maintainers, contractors and even Outreachy interns and mentors this year!

Your ideas and contributions to our projects are still welcome! As a next step, you could consider finishing up any pending pull requests or inform us that someone has to take them over. Here is the recommended place for you to get started as a newcomer: https://www.mediawiki.org/wiki/New_Developers.

If you would still be eligible for Outreachy next year, we look forward to your participation!