Page MenuHomePhabricator

Investigate and improve MediaWiki Action API documentation
Open, HighPublic

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)

Additional notes

Try to address the improvements requested in the following tickets:

Related Objects

StatusAssignedTask
Opensrishakatux
Opensrodlund
Opensrodlund
Opensrodlund
Opensrodlund
Opensrodlund
ResolvedMartyav
Resolvedsrishakatux
DeclinedBisane132
ResolvedMartyav
Resolvedsrishakatux
OpenJayprakash12345
OpenJayprakash12345
Openjeropbrenda
Resolvedsrishakatux
Resolvedsrishakatux
ResolvedCatrope
ResolvedCDanis
Resolvedsrishakatux
Openjeropbrenda
Opensrishakatux

Event Timeline

srishakatux triaged this task as Normal priority.
Anomie moved this task from Unsorted to Non-Code on the MediaWiki-API board.
Anomie added a subscriber: Anomie.

There are currently 26 open tasks tagged with MediaWiki-API and Documentation, but most don't seem relevant to the scope of this task. At first glance, these do:

Whether all of those are actually good ideas or not I couldn't say. T89318 in particular might be questionable, an might need T89768.

Some of the other 21 refer to the documentation output by api.php instead of the on-wiki documentation and some seem oriented to people writing API modules in extensions rather than people writing code that uses the API, while this task seems to be for API-user documentation on mediawiki.org.

If you have questions, feel free to ask me. (:

srishakatux updated the task description. (Show Details)Jul 5 2018, 11:06 PM
bd808 added a project: Goal.Jul 6 2018, 8:47 PM
bd808 raised the priority of this task from Normal to Needs Triage.

Update: @srodlund and I are in the process of moving content from our Sandbox to Mainspace which entails a series of small changes that we are keeping track of here: https://www.mediawiki.org/wiki/User:SSethi_(WMF)/Sandbox/Investigate_and_improve_MediaWiki_Action_API_docs#Work_in_progress

We are linking the pages added, modified, removed or redirected in this section: https://www.mediawiki.org/wiki/User:SSethi_(WMF)/Sandbox/Investigate_and_improve_MediaWiki_Action_API_docs#Results

More and final update to come by the end of this quarter!

srishakatux updated the task description. (Show Details)Oct 31 2018, 6:37 PM
Restricted Application added a subscriber: MusikAnimal. · View Herald TranscriptOct 31 2018, 6:37 PM
srishakatux updated the task description. (Show Details)Nov 22 2018, 8:11 AM
srishakatux updated the task description. (Show Details)Dec 14 2018, 6:53 PM
Martyav updated the task description. (Show Details)Dec 14 2018, 8:05 PM
srishakatux updated the task description. (Show Details)Dec 14 2018, 8:22 PM
Martyav updated the task description. (Show Details)Jan 2 2019, 9:35 PM
Martyav updated the task description. (Show Details)
Martyav updated the task description. (Show Details)Jan 4 2019, 2:20 AM
Martyav updated the task description. (Show Details)Jan 4 2019, 10:25 PM
Martyav updated the task description. (Show Details)Jan 11 2019, 12:36 AM
Martyav updated the task description. (Show Details)
Martyav updated the task description. (Show Details)Jan 16 2019, 8:36 PM
Martyav updated the task description. (Show Details)Jan 17 2019, 6:03 PM
Martyav updated the task description. (Show Details)Jan 17 2019, 7:00 PM
Martyav updated the task description. (Show Details)
Martyav updated the task description. (Show Details)Jan 17 2019, 10:19 PM
Martyav updated the task description. (Show Details)Jan 22 2019, 9:33 PM
Martyav updated the task description. (Show Details)
Martyav updated the task description. (Show Details)
Martyav updated the task description. (Show Details)Jan 22 2019, 9:35 PM
Martyav updated the task description. (Show Details)Jan 23 2019, 5:29 PM
Martyav updated the task description. (Show Details)
Martyav added a subscriber: Martyav.
Martyav updated the task description. (Show Details)Jan 24 2019, 5:36 PM
Martyav updated the task description. (Show Details)Jan 24 2019, 10:28 PM
Martyav updated the task description. (Show Details)Feb 6 2019, 7:19 PM
Martyav updated the task description. (Show Details)Feb 7 2019, 4:24 PM
Martyav updated the task description. (Show Details)
Martyav added a comment.EditedFeb 7 2019, 4:32 PM

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)Feb 20 2019, 7:03 PM
Martyav updated the task description. (Show Details)
Restricted Application added a subscriber: Liuxinyu970226. · View Herald TranscriptApr 16 2019, 6:52 PM
Aklapper renamed this task from Investigate and improve MediaWiki Action API documentation to Investigate and improve MediaWiki Action API documentation.Thu, May 9, 10:11 AM
Pavithraes removed a subscriber: Pavithraes.
srishakatux updated the task description. (Show Details)Tue, May 14, 3:28 AM
srishakatux updated the task description. (Show Details)Tue, May 14, 3:30 AM
srishakatux triaged this task as High priority.