Page MenuHomePhabricator

Develop a UserScript/Gadget tutorial on MediaWiki.org similar to Wikipedia:The_Wikipedia_Adventure
Open, Needs TriagePublic

Description

IMPORTANT: Make sure to read the Outreachy participant instructions and communication guidelines thoroughly before commenting on this task. This space is for project-specific questions, so avoid asking questions about getting started, setting up Gerrit, etc. When in doubt, ask your question on Zulip first!

Project summary

User scripts are programs written in JavaScript for use on Wikimedia projects by users. User scripts enable the Wikimedia user account to do many things that they otherwise couldn't. Like changing DOM, appending HTML snippets in DOM, and changing Interface according to browsers events etc. The project is about to create a guided adventure tour on MediaWiki and MetaWiki(?) to give users insight on “How to create userscript on Wikimedia projects”. The adventure will be designed like The Wikipedia Adventure”[0] which will have 3-4 missions.

  • Mission 1: Basic Intro
  • Mission 2: Using MediaWiki’s JS module
  • Mission 3: Using MediaWiki API
  • Mission 4: Using OOUI (Optional)

Of course, MediaWIki has already good documentation on user script[1] but it is not interactive. The project primarily focuses on newbie developers and existing Wikimedia community members who have little bit knowledge about JavaScript. One of the main benefits of guided tours will be If someone does outreach then every participant should go in one and the same flow (Unlike documentation where anyone starts from the section of page).

Mentor(s)

Indic-MediaWiki-Developers will mentor this project.

  1. @Jayprakash12345
  2. @KCVelaga
  3. @APerson - also known as Enterprisey

Skill required

  • HTML
  • CSS
  • JavaScript
  • jQuery

Resources

[0] https://en.wikipedia.org/wiki/Wikipedia:The_Wikipedia_Adventure
[1] https://www.mediawiki.org/wiki/User_script
[2] https://commons.wikimedia.org/wiki/File:Userscript_and_Gadgets_workshop_toolkit.pdf

Micro tasks

Task 1
  • Install MediaWiki
  • Install the GuidedTour extension to MediaWiki ( you also need to install EventStreamConfig and EventLogging as GuidedTour depends on them)
  • Create a mini tour with any two steps.
  • Make sure your code follows Coding conventions/JavaScript
  • Put the tour code in your MediaWiki's wiki page under your User namespace (Like User:ABC/tour.js)
Task 2
  • Create a basic user script that use OOUI in JavaScript. Be creative and make sure it does not use more than 6 widgets.
  • Make sure your code follows Coding conventions/JavaScript
  • Put the tour code in your MediaWiki's wiki page under your User namespace (Like User:ABC/OOUI-Demo.js)
Task 3
  • Create a basic JavaScript program that makes an interesting query using the MediaWiki API.
  • Try to do something more interesting than getting the text of a page. For example, try getting the items in a category or finding the username of the most recent editor of a page, or something even more complicated.
  • Make sure your code follows Coding conventions/JavaScript
  • Put the tour code in your MediaWiki's wiki page under your User namespace (Like User:ABC/API-Demo.js)

Don't put link of your work here. Share your link in private on Zulip.

Related Objects

StatusSubtypeAssignedTask
OpenNovusistic
DeclinedA.Amritesh
OpenNovusistic
DeclinedRESULTANT_EDITION
DeclinedFritz31
Declinedgauransh_d
DeclinedAwanshrestha1
DeclinedSoumi150
DeclinedSayak17
DeclinedSarthakKundra
InvalidBhalleRam
DeclinedBilalwaheed099
DeclinedNone

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes

Use Zulip Chat for GSoC related communication.

Hey @Jayprakash12345 is there a stream on the Zulip Chat for this project?

hi @Jayprakash12345 @KCVelaga @APerson , can you pls tell where can I clone the project repository from so that I can start working on the microtasks as early as possible?
I've a prior experience in working on tech stacks which are being required for this project.

hi @Jayprakash12345 @KCVelaga @APerson , can you pls tell where can I clone the project repository from so that I can start working on the microtasks as early as possible?
I've a prior experience in working on tech stacks which are being required for this project.

There is no need for repo clone. This project is about on-wiki content. First install MediaWiki then read and follow #2 and #3 of Resources section to kick start.

Jayprakash12345 renamed this task from Write MediaWiki userscript tutorial with adventure tour to Develop a UserScript/Gadget tutorial on MediaWiki.org similar to Wikipedia:The_Wikipedia_Adventure.Mar 10 2021, 6:55 AM
APerson updated the task description. (Show Details)

Hi @Jayprakash12345, @KCVelaga, @APerson Wikimedia has been officially accepted for GSoC 2021! https://summerofcode.withgoogle.com/organizations/5372073939042304/

As the student's applications period is from March 29 - April 13th, I want to encourage you to go through the further steps to ensure there isn't anything that you are missing: https://www.mediawiki.org/wiki/Google_Summer_of_Code/Mentors#_Before_the_program

Hi @Jayprakash12345 @KCVelaga
I am keen to contribute to this idea in the Gsoc 2021 and looking for some background work that could make my path easier. I wanted to ask if these micro tasks are compulsory to be done prior to the application submission by the student, or are they just for familiarising with the work space?

Hello, I am interested in contributing to this project. How should I proceed? Should I first do these micro-tasks?

Hi Homewardgamer and Helix17, please see the steps / information on https://www.mediawiki.org/wiki/Google_Summer_of_Code/Participants - thanks! :)

Hello, @Jayprakash12345 I would like to work on this issue as I am a student and also it is my first time. I want to start my contribution with the open-source if you can help me in getting started then it would be a great thing for me I will try to work upon micro tasks which you have mentioned above. I have also joined zulip channel thanks.

Hello, @Jayprakash12345 I would like to work on this issue as I am a student and also it is my first time. I want to start my contribution with the open-source if you can help me in getting started then it would be a great thing for me I will try to work upon micro tasks which you have mentioned above. I have also joined zulip channel thanks.

Hi, Thanks for showing the interest. Please go through the Resources section to understand about the user scripts. I have also attached all sufficient links to Task 1. Please go to them also.

Hello, @Jayprakash12345 I would like to work on this issue as I am a student and also it is my first time. I want to start my contribution with the open-source if you can help me in getting started then it would be a great thing for me I will try to work upon micro tasks which you have mentioned above. I have also joined zulip channel thanks.

Hi, Thanks for showing the interest. Please go through the Resources section to understand about the user scripts. I have also attached all sufficient links to Task 1. Please go to them also.

Thank you so much as soon I will do some progress on the micro tasks, I will inform you on zulip or will mention it here.

Hey @Jayprakash12345 @APerson !
I have sent the first microtask in private chat to both of you on Zulip. Could you provide some of the feedbacks so that I may take them into consideration while doing other microtasks?

hello,
I am looking to do something interesting during this summer and this project seems quite fascinating to me.
Luckily, I am having some knowledge about the skills mentioned, so would like to give it a shot.
Can anyone explain it a bit more ?

Can anyone explain it a bit more ?

It'd be best if you could ask specific questions to help others answer them.
For help with getting started, see the above discussion and zulip chat.

Hi @Jayprakash12345 @KCVelaga , I tried installing MediaWiki on my system while performing the first task mentioned above. I was done with setting up the database, PHP, and apache2 server on my system. Then I uploaded the MediaWiki installation folder on my apache2 web-server. Now the last part of this whole process is running a configuration script to complete the installation process. But installation guide is assuming some index.php folder in the MediaWiki folder that I uploaded on my server. This index.php file is absent in my case. So I am doubtful about whether I have done all things right up to that step or not. Please guide me. Here is the link to the page where I am currently facing problem: https://www.mediawiki.org/wiki/Manual:Config_script

Thanks !!

Edit : Solved this issue , just re-downloaded the mediawiki installation archieve and get things sort out

Hi, @Jayprakash12345 @KCVelaga @APerson, Myself Sachin, B.tech 3rd-year student at IIT Kanpur. I am familiar with the tech stack this particular project is using and I am interested in working on this one. Although I have been hanging around here for quite a long time, I guess I had not introduced myself formally. By the way, I was trying to do the first task in the list above and I am done with installing MediaWiki on my server. Now I am installing the GuidedTour extension, which requires me to install other extensions like event logging. Although I have downloaded it but do not how to install and run it. I am not getting any clue from its installations page also, https://www.mediawiki.org/wiki/Extension:EventLogging. Please guide me and help me to get familiar with the functioning of MediaWiki in general.

Thank You

Hi, @Jayprakash12345 @KCVelaga @APerson, Myself Sachin, B.tech 3rd-year student at IIT Kanpur. I am familiar with the tech stack this particular project is using and I am interested in working on this one. Although I have been hanging around here for quite a long time, I guess I had not introduced myself formally. By the way, I was trying to do the first task in the list above and I am done with installing MediaWiki on my server. Now I am installing the GuidedTour extension, which requires me to install other extensions like event logging. Although I have downloaded it but do not how to install and run it. I am not getting any clue from its installations page also, https://www.mediawiki.org/wiki/Extension:EventLogging. Please guide me and help me to get familiar with the functioning of MediaWiki in general.

Thank You

Join Zulip, I already gave the answer in "setup" topic under "gsoc2021: Adventure tour" zulip stream.

Hi, I am G.V. Sai Praveen , I am currently pursuing my B.Tech. from BVRIT and I am good to code in HTML, CSS ,JS languages.I think this project is cool and I can work on this project . SO just according to the project ,we have to follow the 3 microtasks and work on them and complete those tasks right? Can anyone let me know in brief what we have to do these 1 week upto 13th April?

Hi @Gvspraveen113. Please see https://www.mediawiki.org/wiki/Outreach_programs/Zulip for general questions unrelated to the task topic - thanks. :)

Hi @Jayprakash12345
i am vivek this project very fascinating and i am familiar with skill required to this project.

can anyone help me for how to setup the enviroment for this project

@Vyaki: Hi, please see the top banner plus previous comments. Thanks.

@Everyone, deadline is near. Please create your proposal as new task here (Point 11) to participate in review.

Hi @Jayprakash12345 I am interested in working on this project ,Please Assign me a microtask

Hi @Jayprakash12345 I am interested in working on this project ,Please Assign me a microtask

There is no need to assign the task to anyone. Everyone is free to do micro task in their own capacity and MediaWiki user page.

@Everyone, If you are interested in this project then create the proposal today here as new task. We will review your proposal tomorrow. After that, you can still submit the proposal on GSoC site but then there will be very short time for mentors to review your proposal and you also, for improvement based on review.

This comment was removed by KCVelaga.

Hello all, thanks for your interest in contributing to open-source projects and submitting proposals for this project. As a final step in our evaluation, we would like to conduct interviews for all applicants on April 27 (Tuesday). No special preparation is required, the interviews will be short (15 min at max) and will be discussing on 3-4 questions (technical, proposal-based, general/motivation, and situational). Please note that this is NOT an optional step and plays a crucial role in the final decision to be made.

The conferencing details and schedule are as follows:

S.NoUser/ApplicantTimeslot
1@A.Amritesh9:30 am - 9:45 am (IST)
2@Novusistic9:45 am - 10:00 am (IST)
3@RESULTANT_EDITION10:00 am - 10:15 am (IST)
4@Fritz3110:15 am - 10:30 am (IST)
5@gauransh_d10:30 am - 10:45 am (IST)
6@Awanshrestha111:15 am - 11:30 am (NPT)
7@Soumi15011:15 am - 11:30 am (IST)
8@Sayak1711:30 am - 11:45 am (IST)
9@SarthakKundra11:45 am - 12:00 pm (IST)
10@BhalleRam12:00 pm - 12:15 pm (IST)
11@Bilalwaheed09911:45 am - 12:00 pm (PKT)

Joining instructions:

  • Please join the above link in the time slot allocated to you only (not prior or later)
  • If the above slot doesn’t work for you for any reason or any other difficulty, please inform us by the end of April 24 (Saturday). We will try our best to find another slot. You can email or ping on hangouts at contact@indicmediawikidev.org
  • If you have any issue connecting on the day of the interview or any other issue, please ping on Hangouts of the above email.

Let us know if you have any doubts.

Sir, I am also interested to be a part of this project but I didn't find my
name in the interview list. Could you please add me to the project and
interview list?

Sir, I am also interested to be a part of this project but I didn't find my
name in the interview list. Could you please add me to the project and
interview list?

You can't. You have not created phab proposal which is mentioned in Application process steps#11. Did you submitted you proposal to GSoC site only?

Yes sir, I have shared my proposal in GSOC. If required ,I will submit my
proposal in phab too soon sir

@Gvspraveen113 For Wikimedia, a Phabricator proposal is an important step in the process. As Jay mentioned, it is already in the instructions. We are not quite sure about eligibility as of now, as the deadline has passed, we will check with the organizational admin and get back to you.

Yes sir, I went through the instructions but I thought applying in GSOC
site was mandatory and phab is optional, but I will share the proposal in
Phab immediately sir

Good evening! I have created my Proposal in Phab. Please review it and let
me know whether it is fine sir .I have created a more detailed proposal in
GSOC site sir but I think the one which I uploaded in Phab is fine. Please
give your review and inputs if any , I will surely work on it.

Yes sir, I went through the instructions but I thought applying in GSOC
site was mandatory and phab is optional, but I will share the proposal in
Phab immediately sir

@Gvspraveen113 Hello! Every step documented here is part of the process https://www.mediawiki.org/wiki/Google_Summer_of_Code/Participants#Application_process_steps including the one about uploading the proposal on Phabricator. Having said that, I would leave it up to the project mentors to decide if they can keep you in the loop of their interview process.

Thank you sir, I had also submitted my proposal in Phab on 25 th after
knowing it was mandatory. I will strictly follow the guidelines from now
onwards.