Jeropbrenda

Outreachy Round 18 intern for project Documentation improvements to the ~20 top 70 most viewed MediaWiki Action API pages on-wiki.

Project Description

The project aims to improve the documentation of the MediaWiki Action API by:

Re-writing it to follow this template.
Adding code samples to demonstrate the use of the API modules.
Developing a demo app based on some of the modules and creating a tutorial to explain its implementation.

Project task: T215682. Also tracked in T198916.

Proposal: T218046.

Mentors: Srishti Sethi and Sarah Rodlund.

Weekly Reports

Week	Dates	Work done
0	May 6 to May 20	Set up blog and user page and subscribed to mailing list. Created a google sheet to analyze the top 50 unimproved pages and group similar pages together, requested for administrator rights on Test Wikipedia.
1	May 20 to May 26	Improved the documentation of the first, second and third module, and submitted pull requests for their sample code. Wrote first blog post.
2	May 27 to June 2	Improved the documentation of the fourth, fifth and sixth module, and submitted pull requests for API:Patrol and API:Watchlist.
3	June 3 to June 9	Wrote second blog post. Improved the documentation of the seventh, eighth and ninth module, and submitted pull requests for their sample code.
4	June 10 to June 16	Improved the documentation of the tenth, eleventh, twelfth, thirteenth and fourteenth module, and submitted pull requests for their sample code.
5	June 17 to June 23	Improved the documentation of the fifteenth and sixteenth page. Started working on the seventeenth page.
6	June 24 to June 30	Completed work on the seventeenth page. Improved the the documentation of the eighteenth and nineteenth page.
7	July 1 to July 7	Improved the documentation of the twentieth page and started working on the twenty-first page.
8	July 8 to July 14	Completed work on the twenty-first page. Started working on the twenty-second page.
9	July 15 to July 21	Started working on the demo app. Presented progress on video chat with mentor.
10	July 22 to July 28	Moved the twenty-second page to the main namespace. Continued working on the demo app.
11	July 29 to August 4	Continued working on the demo app. Created a draft for the tutorial of the demo app.
12	August 5 to August 11	Completed work on the demo app. Hosted the app on Toolforge and added it to the MediaWiki Apps Gallery. Completed working on the tutorial and sent it for review.
13	August 12 to August 20	Moved tutorial to main namespace. Worked on https://github.com/wikimedia/mediawiki-api-demos/issues/163 and https://github.com/wikimedia/mediawiki-api-demos/issues/165.

Project Outcomes

Documentation and Sample Code for Module Pages

#	Documentation	Sample Code
1	API:Protectedtitles	get_protectedtitles.py
2	API:Imageusage	get_imageusage.py
3	API:Import	import_interwiki.py, import_xml.py
4	API:Protect	Was merged during the application period
5	API:Patrol	patrol.py
6	API:Watchlist	get_watchlist.py
7	API:Undelete	undelete.py
8	API:Iwlinks	get_iwlinks.py
9	API:Logevents	get_logevents.py
10	API:Watchlistraw	get_watchlistraw.py
11	API:Tags	get_tags.py
12	API:Allredirects	get_allredirects.py
13	API:Alltransclusions	get_alltransclusions.py
14	API:Assert

Documentation for Overview Pages

#	Documentation
15	API:Meta
16	API:Errors_and_warnings
17	API:Client_code
18	API:Data_formats
19	API:Cross-site_requests
20	API:Etiquette
21	API:Query
22	Wikibase/API

Demo App

Tutorial: API:Holidays_viewer
Pull request: https://github.com/wikimedia/mediawiki-api-demos/pull/161
Live app: https://tools.wmflabs.org/holidays-viewer/