Directory

⚓ T198916 Investigate and improve MediaWiki Action API documentation
Page MenuHomePhabricator
Create Task
Maniphest T198916

Investigate and improve MediaWiki Action API documentation
Closed, ResolvedPublic
Actions

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)

API:Main page (1)Template:APIAPI:Search (5)API:Login (7)API:Parsing wikitext (8)
API:Opensearch (12)API:Account creation (18)API:Tokens (30)API:Images (32)API:Purge (35)
API:Prefixsearch (53)API:Geosearch (100)API:Documentation templateAPI:Languagesearch (112)API:All search modules (118 )
API:Delete (30)API:Redirects (57)API:CategorymembersAPI:Tutorial (6)

Phase 2

Goal: Make improvements to next ~20 viewed API pages

Outcomes

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

API:Links (46)API:Users (41)API:Info (44)API:Allpages (25)API:Imageinfo (45)
API:Allimages (38)API:Categories (24)API:Allcategories (42)API:Lists (17)API:Properties (4)
API:Edit (15)API:Backlinks (39)API:Allusers (49)API:Logout (32)API:Random (26)
API:User group membership (40)API:Watchlist feed (24)API:Parameter information (27)API:Watch (48)API:Move (47)
API:Alllinks (62)API:Usercontribs (55)API:Nearby places viewerAPI:Picture of the day viewerAPI:Article ideas generator

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)

API:Block (36)API:Emailuser (98)API:Options (35)API:Blocks (61)API:Recentchanges (72)
API:Embeddedin (63)API:Exturlusage (64)API:SetPageLanguage (84)API:Deletedrevs (65)API:Querypage (66)
API:AllRevisions (104)API:Upload (20)API:Rollback (43)API:Categoryinfo (100)API:Allfileusages (74)
API:Pagepropnames (82)API:Protectedtitles (73)API:Imageusage (67)API:Import (29)API:Protect (50)
API:Patrol (50)API:Watchlist (56)API:Undelete (53)API:Iwlinks (68)API:Logevents (56)
API:Watchlistraw (89)API:Tags (75)API:Allredirects (76)API:Alltransclusions (71)API:Assert (70)
API:Meta (22)API:Errors_and_warnings (12)API:Cross_site-requests (18)API:Etiquette (28)API:Query (2)
API:Wikibase/API (21)

Additional notes

Try to address the improvements requested in the following tickets:

Related Objects
Search...

StatusSubtypeAssignedTask
 ResolvedsrishakatuxT198916 Investigate and improve MediaWiki Action API documentation
 ResolvedjeropbrendaT203858 Review and improve top viewed overview pages of the Action API
Duplicate• srodlundT204773 Review and improve: https://www.mediawiki.org/wiki/API:FAQ
 ResolvedjeropbrendaT204855 Review and update API client library lists on: https://www.mediawiki.org/wiki/API:Client_code
 ResolvedjeropbrendaT204888 Improve and update: https://www.mediawiki.org/wiki/API:Data_formats
 Duplicate• srodlundT205167 Review and improve: https://www.mediawiki.org/wiki/API:FAQ
 ResolvedMartyavT204612 Outreachy Round 17: Documentation improvements to the ~20 top 50 most viewed MediaWiki Action API pages on-wiki
ResolvedsrishakatuxT205199 [Outreachy] Microtask: Pick a MediaWiki Action API page to review and improve
 DeclinedBisane132T206302 API:IParameter information
 ResolvedMartyavT208291 Proposal: Improving ~20 documentation pages and creating a demo app to help users of MediaWiki learn how to use our APIs - Outreachy 17
 ResolvedsrishakatuxT212006 Ideas for Action API demo app tutorials
 ResolvedJayprakash12345T215681 Develop code samples in Javascript and PHP to demonstrate the use of MediaWiki Action API modules
 ResolvedJayprakash12345T219193 GSoC Proposal: Develop code samples in Javascript and PHP for API Modules
 ResolvedsrishakatuxT227914 Enable tabbedWindow Gadget on test.wikipedia.org
 ResolvedJayprakash12345T228549 Review code snippets (PHP, Javascript & MediaWiki JS) around Action API for on-wiki documentation
 ResolvedLadsgroupT228920 Enable tabbedWindow Gadget on Mediawiki.org
 ResolvedLadsgroupT241077 Enable tabbedWindow Gadget for Help Namespace on Mediawiki.org
 ResolvedjeropbrendaT215682 Outreachy Round 18: Documentation improvements to the ~20 top 70 most viewed MediaWiki Action API pages on-wiki
 ResolvedsrishakatuxT195119 Create user feedback gadget for technical documentation on Wikitech pages
 ResolvedsrishakatuxT211638 Develop EventLogging schema for documentation feedback gadget
 ResolvedCatropeT213779 Review user feedback gadget code
 ResolvedCDanisT213780 Add Srishti to analytics-privatedata-users
 ResolvedsrishakatuxT213782 Deploy user feedback gadget
 ResolvedjeropbrendaT218046 Proposal: Documentation improvements to the ~20 top 70 most-viewed MediaWiki Action API pages, Outreachy Round 18
 ResolvedsrishakatuxT223748 Design and develop a MediaWiki Apps Gallery
 ResolvedsrishakatuxT225584 Enable UserFeedback Gadget on MediaWiki.org
 DeclinedsrishakatuxT232076 Action API documentation quarterly stats
 ResolvedZaycodesT232816 Outreachy Round 19: Documentation improvements to the ~20 top 100 most viewed MediaWiki Action API pages on-wiki

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes
srishakatux mentioned this in T90528: Generated API Help doesn't indicate the MediaWiki versions that support a module and parameters..Sep 11 2018, 1:17 AM
srishakatux added a subtask: T204612: Outreachy Round 17: Documentation improvements to the ~20 top 50 most viewed MediaWiki Action API pages on-wiki .Sep 19 2018, 7:24 PM
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 edited projects, added Developer-Advocacy (Oct-Dec 2018); removed Developer-Advocacy (Jul-Sep 2018).Oct 31 2018, 6:37 PM
srishakatux removed a subscriber: MusikAnimal.
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
srishakatux edited projects, added Developer-Advocacy (Jan-Mar 2019); removed Developer-Advocacy (Oct-Dec 2018).Jan 7 2019, 7:40 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 subscribed.
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

srishakatux mentioned this in T215681: Develop code samples in Javascript and PHP to demonstrate the use of MediaWiki Action API modules.Feb 9 2019, 1:09 AM
srishakatux removed a subtask: T215682: Outreachy Round 18: Documentation improvements to the ~20 top 70 most viewed MediaWiki Action API pages on-wiki.Feb 9 2019, 1:27 AM
Martyav updated the task description. (Show Details)Feb 20 2019, 7:03 PM
Martyav updated the task description. (Show Details)
srishakatux closed subtask T204612: Outreachy Round 17: Documentation improvements to the ~20 top 50 most viewed MediaWiki Action API pages on-wiki as Resolved.Mar 6 2019, 7:44 PM
jeropbrenda mentioned this in T218046: Proposal: Documentation improvements to the ~20 top 70 most-viewed MediaWiki Action API pages, Outreachy Round 18.Mar 18 2019, 6:35 AM
Nikitrain mentioned this in T218015: Proposal: Documentation improvements to the ~20 top 70 most viewed MediaWiki Action API pages on-wiki, Outreachy 18..Mar 21 2019, 6:51 PM
srishakatux moved this task from Jan-Mar 2019 to Apr-Jun 2019 on the Developer-Advocacy board.Apr 16 2019, 6:52 PM
srishakatux edited projects, added Developer-Advocacy (Apr-Jun 2019); removed Developer-Advocacy (Jan-Mar 2019).
Restricted Application added a subscriber: Liuxinyu970226. · View Herald TranscriptApr 16 2019, 6:52 PM
srishakatux closed subtask T212006: Ideas for Action API demo app tutorials as Resolved.Apr 17 2019, 11:47 PM
srishakatux added a subtask: T219193: GSoC Proposal: Develop code samples in Javascript and PHP for API Modules.May 8 2019, 9:38 PM
srishakatux added a subtask: T215682: Outreachy Round 18: Documentation improvements to the ~20 top 70 most viewed MediaWiki Action API pages on-wiki.May 8 2019, 9:55 PM
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
Pavithraes subscribed.May 9 2019, 10:44 AM
Pavithraes unsubscribed.
srishakatux updated the task description. (Show Details)May 14 2019, 3:28 AM
srishakatux triaged this task as High priority.May 14 2019, 3:30 AM
srishakatux updated the task description. (Show Details)
srishakatux added a subtask: T195119: Create user feedback gadget for technical documentation on Wikitech pages.May 14 2019, 3:40 AM
srishakatux added a subtask: T218046: Proposal: Documentation improvements to the ~20 top 70 most-viewed MediaWiki Action API pages, Outreachy Round 18.May 14 2019, 3:46 AM
srishakatux added a subtask: T223748: Design and develop a MediaWiki Apps Gallery.May 18 2019, 6:53 PM
jeropbrenda updated the task description. (Show Details)May 28 2019, 5:25 PM
jeropbrenda updated the task description. (Show Details)May 28 2019, 6:31 PM
srishakatux closed subtask T223748: Design and develop a MediaWiki Apps Gallery as Resolved.Jun 4 2019, 9:17 AM
jeropbrenda updated the task description. (Show Details)Jun 6 2019, 4:17 PM
jeropbrenda subscribed.Jun 6 2019, 5:04 PM

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

srishakatux closed subtask T225584: Enable UserFeedback Gadget on MediaWiki.org as Resolved.Jun 13 2019, 8:22 PM
Tomybrz subscribed.EditedJun 14 2019, 2:02 PM

Please confirm i can delete subpages listed here
Nevermind, done

Tomybrz reopened subtask T225584: Enable UserFeedback Gadget on MediaWiki.org as Open.Jun 15 2019, 1:40 PM
jeropbrenda updated the task description. (Show Details)Jun 17 2019, 7:10 AM
Tomybrz closed subtask T225584: Enable UserFeedback Gadget on MediaWiki.org as Resolved.Jun 18 2019, 7:38 AM
jeropbrenda updated the task description. (Show Details)Jun 29 2019, 5:21 PM
srishakatux moved this task from Apr-Jun 2019 to Jul-Sep 2019 on the Developer-Advocacy board.Jul 3 2019, 3:37 PM
srishakatux edited projects, added Developer-Advocacy (Jul-Sep 2019); removed Developer-Advocacy (Apr-Jun 2019).
jeropbrenda mentioned this in T359: Document the Wikidata API in the Developer Hub.Jul 13 2019, 6:04 PM
jeropbrenda updated the task description. (Show Details)Jul 26 2019, 3:53 PM
Restricted Application added a project: Platform Engineering. · View Herald TranscriptJul 26 2019, 3:53 PM
Anomie removed a project: Platform Engineering.Jul 26 2019, 4:06 PM
srishakatux added a parent task: T169599: Sort out concept for overview/entrance pages targeting our developer audience.Aug 22 2019, 10:12 AM
srishakatux removed a parent task: T169599: Sort out concept for overview/entrance pages targeting our developer audience.Aug 22 2019, 10:15 AM
srishakatux closed subtask T215682: Outreachy Round 18: Documentation improvements to the ~20 top 70 most viewed MediaWiki Action API pages on-wiki as Resolved.Sep 3 2019, 9:42 PM
jeropbrenda closed subtask T218046: Proposal: Documentation improvements to the ~20 top 70 most-viewed MediaWiki Action API pages, Outreachy Round 18 as Resolved.Sep 4 2019, 4:55 PM
Jayprakash12345 closed subtask T219193: GSoC Proposal: Develop code samples in Javascript and PHP for API Modules as Resolved.Sep 4 2019, 9:59 PM
srishakatux closed subtask T215681: Develop code samples in Javascript and PHP to demonstrate the use of MediaWiki Action API modules as Resolved.Sep 4 2019, 10:08 PM
srishakatux lowered the priority of this task from High to Medium.Sep 4 2019, 10:45 PM
srishakatux edited projects, added Developer-Advocacy, Epic; removed Developer-Advocacy (Jul-Sep 2019), Goal.
srishakatux added a subtask: T232816: Outreachy Round 19: Documentation improvements to the ~20 top 100 most viewed MediaWiki Action API pages on-wiki.Sep 13 2019, 7:02 PM
Amorymeltzer subscribed.Sep 13 2019, 7:06 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.
srishakatux closed subtask T203858: Review and improve top viewed overview pages of the Action API as Resolved.Oct 15 2019, 9:40 PM
• srodlund mentioned this in T234634: Wikimedia Technical Conference 2019 Session: On-wiki documentation & documentation as code: strengths, weaknesses, and compromises.Oct 17 2019, 3:41 PM
srishakatux closed subtask T232076: Action API documentation quarterly stats as Declined.Dec 5 2019, 9:25 PM
srishakatux closed subtask T232816: Outreachy Round 19: Documentation improvements to the ~20 top 100 most viewed MediaWiki Action API pages on-wiki as Resolved.Mar 13 2020, 9:05 PM
srishakatux closed this task as Resolved.Mar 13 2020, 9:12 PM

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 :)

awight awarded a token.May 13 2020, 7:26 AM
Aklapper removed a subscriber: Anomie.Oct 16 2020, 5:43 PM
Aklapper edited projects, added Developer-Advocacy (Jan-Mar 2020); removed Developer-Advocacy.Nov 8 2020, 10:37 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits