Page MenuHomePhabricator

Outreachy Round 18 Proposal: Documentation improvements to the ~20 top 70 most viewed MediaWiki Action API pages on-wiki
Closed, DeclinedPublic

Description

Profile Information

Name : Areefa Thassim
Email : thassim97@hotmail.com
Github : https://github.com/reefagirl
LinkedIn Profile : https://www.linkedin.com/in/areefa-thassim/
Curriculum Vitae : Areefa Thassim CV
Location : Sri Lanka (UTC +5:30)
Typical working hours : Between 10 am and 8 pm UTC +5:30

Synopsis

This project aims to reduce the inconsistancy of documenting MediaWiki Action API pages using a documentation template.

  • To write sample code where necessary
  • To create documentation pages according to the template
  • To create demo apps using MediaWiki action APIs

Mentors : @srishakatux

Timeline

PeriodTask
May 6 to May 20Community bonding period. Doing research and looking into the API pages that needed to be documented using the template. Identifying API's with no samples or incomplete samples.
May 20 to July 29Complete documentation improvements to the 20 top 70 most viewed MediaWiki Action API pages on wiki (Implementation plan below)
June 29 to August 20Work on demo apps around the use of Action API's (Target: 2)

For the first 10 weeks I will complete 2 API samples and documentation pages per week. The weekly plan is as follows;

  • Day 1 - API sample code
  • Day 2 - Create pull request and request for feedback. While it is reviewed get started on documentation
  • Day 3 - Complete documentation and prepare for next API.
  • Day 4 - work on feedback and sample code for next API
  • Day 5 - Create pull request for next API and begin documentation.
  • Day 6 - Complete documentation and work on any feedback
  • Day 7 - review and complete pull requests by working on further feedback.

Deliverables

  • Complete documentation for the 20 top 70 most viewed MediaWiki Action API pages on wiki
  • 2 Demo Apps
  • Weekly blog updates on progress

Participation

  • I will make a new repo on git and maintain two branches. Code will be uploaded to the dev branch periodically and will be merged with the master branch once review and testing is done.
  • I will be online on Zulip chat during my working hours ( 10:00 am to 8:00 pm UTC +5:30) to collaborate with the mentors.
  • I will use Phabricator for managing bugs and subtasks.
  • I will be available by email to be contacted when needed in the non-working hours.
  • I will provide weekly updates to my mentor on my progress
  • I will write a blog post weekly, on the tasks I have completed

About Me

I am currently in my industrial placement year (Year 3) of my Computer Science degree at IIT Sri Lanka (affiliated with the University of Westminster London).

As part of my industrial placement I am working at Millennium IT Sri Lanka. I am a part of the AI Team and work with many technologies revolving RPA, Chatbots, Voice integration and Face integration via API's. I also do technical writing and demo presentations to clients.

My internship contract ends in May, while my next semester begins in September freeing me from commitments during the internship period.

Outreachy helped introduce me to the open source sphere and I was very proud to make my first contribution to this space via the Wikimedia organization. It has taught me the impact that can be made through free and open source software. The vision of Wikimedia inspires me to make the web more accessible and available by the efforts taken to ensure translation and quality of software exposed to the world

Past Experience

My course work in my degree has helped me acquire skills in Java, Javascript, Web technologies, Python, Databases, Software design and communication skills.
During my internship I have been able to build on these skills and improve them. I have learned to create solutions, designs, documentation that caters to the need of people

Microtasks Completed

Other MediaWIki tasks I am currently working on

Other Projects I have worked on

  • HelloMom - An SMS based application that aims to reduce maternal and infant mortality by empowering women with knowledge and information. The application guides women through a healthy pregnancy and ensures they are reminded about vaccinations for their health as well as their baby's health.

Project outline and details can be found here

  • LetMeSpeak (Ya Dolala) - A gamified approach to overcoming speech impediments in children. A mobile application that allows kids to practice their speech therapy via interactive games, LetMeSpeak would also provide reports on how the user is faring in terms of carrying out the exercises.

Project Overview can be found here

Event Timeline

@Areefa I've read your proposal, and it looks good to me. Totally optional: you could include in your proposal a project you've worked on previously, needn't be a big project, and also a link to it on Github or elsewhere.
Whenever you are ready, you can submit your proposal on the Outreachy site and move it to the "Proposals Submitted" column on the Outreachy (Round 18) workboard in Phabricator.

sorry for moving your task by mistake :)

@srishakatux Thanks, I'll include a few projects I've completed.

Areefa updated the task description. (Show Details)

(look for next steps in the email that you'll receive shortly with an option to request for a debrief on why your proposal was not accepted)