Page MenuHomePhabricator

Outreachy Proposal: Improving documentation of ~20 top 70 most viewed MediaWiki Action API pages on-wiki
Closed, DeclinedPublic

Description

Profile Information

Name : Silky Priya
IRC nick : Silky44
Email : silkypriya64@gmail.com
Github : https://github.com/silkypriya
Location : India
Time Zone : UTC +5:30
Typical working hours : Between 2 pm and 3 am UTC +5:30

Synopsis

The MediaWiki action API is a web service that allows access to some wiki-features. Inconsistencies in formatting, in how much and what kind of information is included, in presence of sample code are some of the addressed problems with the ~128 pages on the Action API on MediaWiki.org. The project aims to improve documentation using designed documentation template.

First Part :
Documentation improvement ~20 top 70 most viewed MediaWiki Action API pages on-wiki.

Second Part :
Develop Demo Apps to demonstrate the use of Action APIs.

Mentor : @srishakatux ( Srishti Sethi - Wikimedia Foundation )

Deliverables

  • Documentation Improvement of ~20 MediaWiki Action API pages on-wiki before mid-point evaluation.
  • Develop two Demo Apps to demonstrate the use of Action APIs after mid-point evaluation.
  • Biweekly blog posts chronicling my journey.

Timeline

Week 1 (May 20 - May 26)

  • Discussion with mentors to decide the APIs for documentation improvement and Demo App implementation.
  • Documentation Improvement of two APIs.

Week 2 (May 27 - June 02)

  • Documentation Improvement of three APIs.
  • Blog post describing my first 2 weeks experience working with this project.

Week 3 (June 03 - June 09)

  • Improvements and changes according to initial feedback.
  • Documentation Improvement of three APIs.

Week 4 (June 10 - June 16)

  • Documentation Improvement of three APIs.
  • Blog post describing my past 2 weeks experience working with this project.

Week 5 (June 17 - June 23)

  • Documentation Improvement of three APIs.

Week 6 (June 24 - June 30)

  • Documentation Improvement of three APIs.
  • Blog post describing my past 2 weeks experience working with this project.

Week 7 (July 01 - July 07)

  • Documentation Improvement of three APIs.
  • Complete documentation improvement work before mid-point feedback.

Week 8 (July 08 - July 14)

  • Improvements and changes according to mid-point feedback.
  • Blog post describing my past 2 weeks experience working with this project.
  • Start working with First Demo App (Complete UI)

Week 9 (July 15 - July 21)

  • Polishing UI, complete coding for First Demo App.

Week 10 (July 22 - July 28)

  • Deploying and testing of First Demo App.
  • Complete documentation for First Demo App.
  • Blog post describing my past 2 weeks experience working with this project.

Week 11 (July 29 - August 04)

  • Start working with Second Demo App (Complete UI)

Week 12 (August 05 - August 11)

  • Polishing UI, complete coding for Second Demo App.
  • Blog post describing my past 2 weeks experience working with this project.

Week 13 (August 12 - August 20)

  • Deploying and testing of Second Demo App.
  • Complete documentation for Second Demo App.
  • Blog post about my entire journey with this project.

Participation

  • I will make a new repo on git and maintain two branches. Code will be uploaded to the Test branch periodically and will be merged with the master branch once review and testing is done.
  • I will contact with my mentor on Zulip Chat and Phabricator for managing subtasks.
  • I will be online on IRC in my working hours.
  • I will my blog the summary of a task at the end of a task period as above in the timeline.
  • I will be available in gmail to be contacted when needed in the non-working hours.

About me

Currently in the final year of B.Tech in Computer Science and Engineering in Indian Institute of Technology, Roorkee. I will graduate in May 2019. I will be able to commit all my time for the project as I have not any other commitments during this period.I am only applying for Outreachy this summer.

What inspired me to work on this project is that I like the concept of letting students submit assignments as wikipedia content which the whole world can see I would like to continue contributing to this project and it would be great to implemented more Demo Apps demonstrating Action APIs.

Past Experience

  • I have gained experience with JAVA, PYTHON, HTML, CSS, JAVASCRIPT, GIT by working in college Technical teams.
  • I like to participate in Appathons (I develop Android apps) and have creates several Android apps.
  • I have experience of clear and concise writing of communications and development documentation.

Microtasks completed

Documnetation Improvements

Event Timeline

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMar 18 2019, 2:31 PM
SilkyPriya updated the task description. (Show Details)Mar 18 2019, 2:32 PM

sorry for moving your task by mistake :)

srishakatux closed this task as Declined.May 7 2019, 1:05 AM

(accepted for another project)