Page MenuHomePhabricator

Improve documentation of a MediaWiki Action API page (cloneable)
Open, Needs TriagePublic

Description

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

https://www.mediawiki.org/wiki/User:Pavithraes/Sandbox/MediaWiki_documentation_improvements_project_guidelines

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.

Mentors

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

Event Timeline

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptTue, Nov 5, 7:19 PM
Mvolz added a subscriber: Mvolz.Wed, Nov 6, 11:05 AM

Hi Mentors, feel free to import this into https://codein.withgoogle.com yourself! Let me know if you have any questions.

@Urbanecm Are we restricted to IRC as a communication tool or can we use Zulip as well?

@Urbanecm Are we restricted to IRC as a communication tool or can we use Zulip as well?

I guess it's fine to use other communication tools than IRC, however, IRC is quite live during GCI and it can be fun experience for students to interact with other students, mentors and by-standers :-).

@Urbanecm Noted, thank you :)

Mvolz added a comment.Fri, Nov 15, 2:07 PM

I was a little confused by the title, is the task to fix a single api page each, or for each participant to complete 10 pages? I think from the wording of the text it's a single page each, but the title makes it sounds like the student has to do all 10 pages, so I've updated the GCI page accordingly, but feel free to put it back if that's not the case :).

Mvolz renamed this task from Improve documentation of ~10 MediaWiki Action API pages to Improve documentation of a MediaWiki Action API page.Fri, Nov 15, 2:07 PM
Mvolz renamed this task from Improve documentation of a MediaWiki Action API page to Improve documentation of a MediaWiki Action API page (cloneable).

I was a little confused by the title, is the task to fix a single api page each, or for each participant to complete 10 pages? I think from the wording of the text it's a single page each, but the title makes it sounds like the student has to do all 10 pages, so I've updated the GCI page accordingly, but feel free to put it back if that's not the case :).

I guess it's single page each, given the task has instance count of 10.

I've unchecked the Beginner task field, and published the task. That field is here for _really_ simple tasks like "set up your dev environment and send us a screenshot in your language", "send a patch to Gerrit" or similar.

@jeropbrenda Since you're listed as a mentor in the description, I've added you to the task in GCI. Feel free to remove yourself if you disagree :-).

@Mvolz @Urbanecm Thank you!! And yes, it's one page each. :)