Description
The MediaWiki action API is a web service that allows access to some wiki-features like authentication, page operations, and search. It can also 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 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 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. :-)
Goal
To improve documentation of ~10 MediaWiki Action API pages on-wiki using the documentation template.
Getting started
Skills required
- Working with wiki pages.
- Basic Python, PHP and JavaScript programming.
Note: These skills are nice-to-have. Come with a desire to learn and that be all!
Code repository
https://github.com/wikimedia/MediaWiki-Action-API-Code-Samples
Resources
Tasks
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 |
| API:Langbacklinks | ||
| API:Userinfo | ||
| API:Langlinks | ||
| API:Templates | ||
| API:Pageprops | ||
| API:Coderevisions | ||
| API:Extlinks | ||
| API:Linkshere | ||
| API:Help | ||
| API:Allmessages | ||
Mentors
- Jerop Brenda @jeropbrenda
- Pavithra Eswaramoorthy @Pavithraes
Contact the mentors over IRC: wikimedia-tech on Freenode.
Additional details
Time to complete: 3 days
Task Categorization: Beginner
Instance Count: 10
Categories: Documentation/Training, Code
Tags: Documentation, API, Python, JavaScript, PHP