Proposal for https://phabricator.wikimedia.org/T215682
===Profile Information
Name: Edidiong Asikpo
Github: https://github.com/Edyasikpo
Blog: https://medium.com/@EdidiongAsikpo
IRC handle: Didicodes
Web Profile:
Resume: https://docs.google.com/document/d/1NEbg5Ii8yE6pCdquCg6dtSlYcjDX7RjC1HNiLxWFad4/edit?usp=sharing
Location: Lagos, Nigeria
Time Zone: (UTC + 01:00) West Central Africa
Typical working hours: 11 AM - 8 PM (UTC + 01:00) West Central Africa
User Page: https://www.mediawiki.org/wiki/User:Didicodes
===Summary
As described on the Outreachy task(https://phabricator.wikimedia.org/T215682),
|The MediaWiki action API is a web service that allows access to some wiki-features like authentication, page operations, and search. It can provide meta information about the wiki and the logged-in user. Several Wikimedia projects make use of this API. As of now, there are ~128 pages on the Action API on MediaWiki.org. Developer-Advocacy did a little research on the state of the docs and documented a few problems and recommendations for the next steps. One of the issues we decided to address was inconsistency. For example, some pages had the automated API docs embedded; some didn’t, some pages had code samples, some didn’t, etc. As a first step, we designed a documentation template and used it to re-write top 20 viewed pages of the API. But, we realized we could not improve 128 pages all by ourselves, and opened it to new Wikimedia contributors for help :-) Our Outreachy intern Martyav put in a lot of good work in this and improved the next ~20 pages and brought this project in good shape. The goal of this project is to improve documentation of ~20 top 70 most viewed MediaWiki Action API pages on-wiki using the documentation template. (OPTIONAL) If there is more time, then the next part of the project could be developing one or two demo apps around the use of Action APIs.
=== Mentors
Srishti Sethi (@srishakatux) and Sarah Rodlund(@srodlund)
===Deliverables
* 2 to 3 improved API documentations weekly.
* Biweekly blog posts onabout my progress every two weeksss.
* Build a Demo App integrating API: Prefixsearch and API:Backlinks
* Regular communication with my mentors and other community members at WMF.
* Build a Demo App for API: Categorymembers
===Timeline
16th November - 3rd December
* Community bonding period.
* Study the API pages that have already been improved and integrated(This will help me gain more
knowledge).
* Study the Top 30 API pages and start writing sample codes for every page that requires sample codes(I am
doing this because I realized that writing the codes took a longer time than improving the documentation
doing this because I realized that writing the codes took a longer time than improving the documentation itself for me, I believe this will make working on the pages easier when the internship starts).
* Read the related API documentation
* Start working on the API:Prefixsearch
===About Me
I am a graduate of the Department of Computer Science, Renaissance University, Nigeria. I am a keen observer and I love to learn new things and work in collaboration with people. This will be my first participation in the Outreachy Programme.
- How did I hear about outreachy?
I heard about the outreachy program on social media(Facebook ), I saw it on a post made by an open source advocate on my timeline. It looked interesting so I asked him for more explanations then clicked on the link, read about it and decided to apply for it.
- Will I have any other time commitments, such as school work, another job, planned vacation, etc, during the duration of the program?
No!
- What does making this project happen mean to me?
I am particularly interested in this project because of all the amazing information I have gotten from the free encyclopedia (Wikipedia). Wikipedia has always been one of the best sources of acquiring any information I was looking for since I was younger, I literally always found almost everything I needed and it got me wondering how the owners of Wikipedia could achieve this. So it would basically be an honor for me to contribute and help more people in the world get the correct information they are all searching for. The fact that the codes or documentation I contribute would be merged someday and thousands of people all over the world would use it is the most exciting part of this journeywhile I was younger.
Personally, I know how difficult it is when a user goes through documentation that are not clear enough.
===Past Experience
====Open Data Kit
Open Data Kit is a free and open-source set of tools for collecting data in challenging environments.
https://github.com/opendatakit/collect/pull/2045
Eager to give open source contribution a try in 2018, the above repository was my first time participating in open source. I wrote codes that made the Collect App support escaping markdown characters using a backslash. I used Java and regular expressions (Regex) to work on this. I was so excited when my commits were merged to the ODK’s main repository.
==== MediaWiki
I joined the MediaWiki Community on the 20th of September , 2018 as an outreachy applicant for the project “Documentation improvements to the top 50 most viewed API pages on the MediaWiki Action API”. Even though I didn't get selected for the spot, I learnt how to edit wiki pages, write templates, use phabricator and improve my coding skills in python.
I was able to make the following contributions listed below:
Sample Codes for API:Purge
https://github.com/srish/MediaWiki-Action-API-Code-Samples/pull/5 **Merged**
Sandbox for drafting improvements to API:Purge page
https://www.mediawiki.org/wiki/User:Didicodes/Sandbox/API:Purge **Approved**
Sample codes for API:Account_Creation
https://github.com/srish/MediaWiki-Action-API-Code-Samples/pull/1 **Merged**
Sandbox for drafting improvements to API:Account_Creation page
https://www.mediawiki.org/wiki/User:Didicodes/Sandbox/API:Account_creation
Sample codes for API:Random
https://github.com/srish/MediaWiki-Action-API-Code-Samples/pull/12
Sandbox for drafting improvements to API:Random Page
https://www.mediawiki.org/wiki/User:Didicodes/Sandbox/API:Random
**For outreachy 18 I madwas able to make the following contributions below**
Sample codes for API:Embeddedin
https://github.com/wikimedia/MediaWiki-Action-API-Code-Samples/pull/74 **Merged**
Sandbox for drafting improvements to API:Embeddedin
https://www.mediawiki.org/wiki/User:Didicodes/Sandbox/API:Embeddedin
Sample codes for API:Rollback
https://github.com/wikimedia/MediaWiki-Action-API-Code-Samples/pull/79
Sandbox for drafting improvements to API:Rollback
https://www.mediawiki.org/wiki/User:Didicodes/Sandbox/API:Rollback
Sample codes for API:Pagepropnames
https://github.com/wikimedia/MediaWiki-Action-API-Code-Samples/pull/91
Sandbox for drafting improvements to API:Pagepropnames
https://www.mediawiki.org/wiki/User:Didicodes/Sandbox/API:Pagepropnames
==== ToDo List App
==== Microblog
==== Sunshine
==== Dad Jokes