==Brief summary==
The [[ https://www.mediawiki.org/wiki/API:Main_page | 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 [[ https://www.mediawiki.org/wiki/Category:MediaWiki_action_API | 128 pages ]] on the Action API on MediaWiki.org. #developer-advocacy did a little [[ https://www.mediawiki.org/wiki/User:SSethi_(WMF)/Sandbox/Research_on_the_state_of_the_docs_of_mw_action_api | research on the state of the docs ]] and documented a few problems and recommendations for 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 [[ https://www.mediawiki.org/wiki/API:Documentation_template | documentation template ]] and used it to re-write the 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 :-) The next 60 pages were improved in the last two Outreachy rounds.
The goal of this project is to improve documentation of ~20 top 100 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 a bot that mass edits sample code from [[https://github.com/wikimedia/MediaWiki-Action-API-Code-Samples|this repository]] to the API namespace on MediaWiki.org and vice-versa, as explained in https://github.com/wikimedia/mediawiki-api-demos/issues/172.
==Skills required==
- Wiki editing, Templates, creating and managing translatable pages.
- [[ https://phabricator.wikimedia.org/ | Wikimedia Phabricator ]] tool.
- Basic Python, PHP and JavaScript programming.
Note: some or all of these skills would be nice to have but not required. Come with a desire to learn and that be all!
== Code repository==
https://github.com/wikimedia/MediaWiki-Action-API-Code-Samples
== Microtasks==
==== Microtask 1: Pick a MediaWiki Action API page to review and improve====
Pick an API page to work on and add your Phabricator username next to it in the relevant column
| API page | Work in progress | Done
| [[ https://www.mediawiki.org/wiki/API:Siteinfo | API:Siteinfo ]] |Linda-Ikechukwu4|
| [[ https://www.mediawiki.org/wiki/API:Iwbacklinks | API:Iwbacklinks ]] |Samuel Ndu|
| [[ https://www.mediawiki.org/wiki/API:Pageswithprop | API:Pagewithprop ]] |Priscila Vilemen|
| [[ https://www.mediawiki.org/wiki/API:Mergehistory | API:Mergehistory ]] | Zaycodes |
| [[ https://www.mediawiki.org/wiki/API:Revisiondelete | API:Revisiondelete ]] | TawandaMoyo |
| [[ https://www.mediawiki.org/wiki/API:Expandtemplates | API:Expandtemplates ]] |Supriya (pineappled_sun)|
| [[ https://www.mediawiki.org/wiki/API:ClearHasMsg | API:ClearHasMsg ]] | Barbontempo |
| [[ https://www.mediawiki.org/wiki/API:Compare | API:Compare ]] |Lucideuclid|
| [[ https://www.mediawiki.org/wiki/API:Contributors | API:Contributors ]] | AwahNadege |
| [[ https://www.mediawiki.org/wiki/API:Tag | API:Tag ]] | Sabin10|
| [[ https://www.mediawiki.org/wiki/API:Validatepassword | API:Validatepassword ]] | Evigian|
| [[ https://www.mediawiki.org/wiki/API:Duplicatefiles | API:Duplicatefiles ]] |Maryey|
| [[ https://www.mediawiki.org/wiki/API:Filerepoinfo | API:Filerepoinfo ]] |Fareena Fatima|
| [[ https://www.mediawiki.org/wiki/API:Deletedrevisions | API:Deletedrevisions ]] |Vanesa Perea|
| [[ https://www.mediawiki.org/wiki/API:Alldeletedrevisions | API:Alldeletedrevisions ]] |Dikshagupta99|
| [[ https://www.mediawiki.org/wiki/API:Setnoificationtimestamp | API:Setnotificationtimestamp ]] |Larissa Sales|
| [[ https://www.mediawiki.org/wiki/API:Stashedit | API:Stashedit ]] | Zaycodes |
| [[ https://www.mediawiki.org/wiki/API:Managetags | API:Managetags ]] |Ruba |
| [[ https://www.mediawiki.org/wiki/API:Filerevert | API:Filerevert ]] |VickieCMitchell|
| [[ https://www.mediawiki.org/wiki/API:Checktoken | API:Checktoken ]] |Ola Efimova|
| [[ https://www.mediawiki.org/wiki/API:Linkaccount | API:Linkaccount ]] |Yamakat|
| [[ https://www.mediawiki.org/wiki/API:Filearchive | API:Filearchive ]] |Liz Kariuki|
| [[ https://www.mediawiki.org/wiki/API:Rsd | API:Rsd ]] ||
===== Getting started instructions =====
https://www.mediawiki.org/wiki/Outreachy/Round_19/MediaWiki_documentation_improvements_project_guidelines
====Microtask 2====
{T235395}
**Note: Any documentation or API-related task you work on qualifies as a valid contribution too.**
Please see:
* https://phabricator.wikimedia.org/project/view/987/ for documentation-related tasks.
* https://phabricator.wikimedia.org/tag/mediawiki-api/ for API-related tasks.
==Mentor(s)==
@jeropbrenda
==Get in touch with mentors==
Ask a question in the topic `Phab:T232816 API documentation improvements` under https://wikimedia.zulipchat.com/#narrow/stream/208145-outreachy19
== Resources ==
* How to use or write Templates https://www.mediawiki.org/wiki/Help:Templates
* Page translation https://www.mediawiki.org/wiki/Help:Extension:Translate/Page_translation_example
* Editing wiki pages https://www.mediawiki.org/wiki/Help:Editing
* Learn how to use Phabricator https://www.mediawiki.org/wiki/Phabricator/Help
**Note: Please do not claim this task or set the "Assignee" field as several people are expected to work on it.**