Outreachy/Round 18

Wikimedia is participating in Outreachy Round 18. Internship period runs from May 20th to August 20th, 2019. Read information for participants  Read information for mentors

Program timeline
(borrowed from https://www.outreachy.org/apply/project-selection/)

Ideas for projects
Watch this space for project ideas! Projects will also be listed on the Outreachy portal here: https://www.outreachy.org/may-2019-august-2019-outreachy-internships/communities/wikimedia/.

Documentation improvements to the ~20 top 70 most viewed MediaWiki Action API pages on-wiki
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. Our team 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 contributors for help. Our Outreachy intern User:Martyav put in a lot of good work in the project in Round 17 and improved the next ~20 pages and brought this project in good shape! The goal of this project in Round 18 would be to improve documentation of ~20 top 70 most viewed MediaWiki Action API pages on-wiki using the documentation template. 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.

Skills required Basic python programming, editing wiki pages, familiarity with collaboration tools (e.g., Phabricator and Github), etc.

More details https://phabricator.wikimedia.org/T215682

Mentors Srishti Sethi, Sarah Rodlund

Contact

 * Reach out for general questions on the #gsoc19-outreachy18 Zulip chat
 * Ask a technical question on the Wikimedia Developer Support channel