Page MenuHomePhabricator

Investigate and improve MediaWiki Action API documentation
Closed, ResolvedPublic

Description

Phase 1

Goal: Make improvements to top ~20 viewed API pages

Outcomes

  • Researched the state of the MediaWiki Action API docs (see details here).
  • Promoted the project in Outreachy: T204612.
  • Developed a research study to assess the work so far and inform ideas for future work.
  • Made improvements to the following ~20 pages including the homepage and a documentation template.

Pagename (massviews ranking between 7/1/2017 - 10/30/2018)

Phase 2

Goal: Make improvements to next ~20 viewed API pages

Outcomes

Pagename (massviews ranking between 7/1/2017 - 10/30/2018)

Phase 3 (ongoing)

Goal(s):

  • Develop code samples in Javascript and PHP to demonstrate the use of MediaWiki Action API modules: T215681 (via GSoC)
  • Improve next ~20 pages: T218046 (via Outreachy)

Pagename (massviews ranking between 7/1/2017 - 10/30/2018)

Additional notes

Try to address the improvements requested in the following tickets:

Related Objects

StatusSubtypeAssignedTask
Resolvedsrishakatux
Resolvedjeropbrenda
Duplicatesrodlund
Resolvedjeropbrenda
Resolvedjeropbrenda
Duplicatesrodlund
ResolvedMartyav
Resolvedsrishakatux
DeclinedBisane132
ResolvedMartyav
Resolvedsrishakatux
ResolvedJayprakash12345
ResolvedJayprakash12345
Resolvedsrishakatux
ResolvedJayprakash12345
ResolvedLadsgroup
ResolvedLadsgroup
Resolvedjeropbrenda
Resolvedsrishakatux
Resolvedsrishakatux
ResolvedCatrope
ResolvedCDanis
Resolvedsrishakatux
Resolvedjeropbrenda
Resolvedsrishakatux
Resolvedsrishakatux
Declinedsrishakatux
ResolvedZaycodes

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes
Martyav updated the task description. (Show Details)
Martyav updated the task description. (Show Details)
Martyav updated the task description. (Show Details)
Martyav updated the task description. (Show Details)
Martyav updated the task description. (Show Details)
Martyav updated the task description. (Show Details)
Martyav added a subscriber: Martyav.
Martyav updated the task description. (Show Details)

For clarity in regards to my activity on the thread: I am an intern working with Srishti & Sarah on updating the top 50 most frequently viewed Action API pages. My workflow is to create drafts in my Sandbox, make the page conform to the template (https://www.mediawiki.org/wiki/API:Documentation_template), research the API and update the article accordingly, and provide Python sample code and JSON responses.

A complete list of my work on this project can be viewed here, including any works in progress: https://www.mediawiki.org/wiki/User:Martyav#Articles

Martyav updated the task description. (Show Details)
Aklapper renamed this task from Investigate and improve MediaWiki Action API documentation to Investigate and improve MediaWiki Action API documentation.May 9 2019, 10:11 AM
srishakatux updated the task description. (Show Details)

Outreachy 18 initial feedback update: I've improved 9 pages in my sandbox, and seven of them have been merged to the main namespace. More detailed information available at https://www.mediawiki.org/wiki/User:Jeropbrenda#Project_Outcomes

Please confirm i can delete subpages listed here
Nevermind, done

srishakatux lowered the priority of this task from High to Medium.Sep 4 2019, 10:45 PM
srishakatux lowered the priority of this task from Medium to Low.Sep 26 2019, 11:32 PM
srishakatux moved this task from To triage to Backlog on the Developer-Advocacy board.

We made improvements to ~100 pages in the API namespace as part of this project; more details are in this blog post:
https://medium.com/@Srish_Aka_Tux/fixing-the-docs-is-a-group-effort-786367733d83. One of the things we focused on especially was consistency and ensuring that all pages adhere to the documentation template here: https://www.mediawiki.org/wiki/API:Documentation_template.

Thank you to folks who worked on this documentation project and made wonderful contributions to it :)