Maniphest T357444

Migrate EventLogging to JSDoc
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	apaskulin
	Feb 13 2024, 5:06 PM

Tags

Referenced Files

None

Subscribers

Description

EventLogging currently uses JSDuck, which is being replaced with JSDoc as part of T138401

To do:

Update the config and build files
Adjust the tags to comply with JSDoc
Build the docs locally with the WMF theme, and verify that the information from the JSDuck site is present on the new JSDoc version

Resources:

Migration guide: https://phabricator.wikimedia.org/T138401
JSDoc wiki page: https://www.mediawiki.org/wiki/JSDoc
Local development instructions for the JSDoc WMF theme: https://gerrit.wikimedia.org/g/jsdoc/wmf-theme

Details

	Subject	Repo	Branch	Lines +/-
	docs: Replace JSDuck with JSDoc	mediawiki/extensions/EventLogging	master	+647 -43

Customize query in gerrit

Related Objects
Search...

		Status	Subtype	Assigned	Task
		Resolved		phuedx	T357003 Fix public documentation for mw.eventLog.submit() and dispatch()
		Resolved		apaskulin	T357444 Migrate EventLogging to JSDoc

Event Timeline

apaskulin created this task.Feb 13 2024, 5:06 PM

Restricted Application added a project: Data-Engineering. · View Herald TranscriptFeb 13 2024, 5:07 PM

Restricted Application added a subscriber: Aklapper. · View Herald Transcript

apaskulin mentioned this in T138401: Replace jsduck with JSDoc3 across all Wikimedia code bases.Feb 13 2024, 5:08 PM

apaskulin mentioned this in T357003: Fix public documentation for mw.eventLog.submit() and dispatch().Feb 13 2024, 5:11 PM

lbowmaker moved this task from Incoming (new tickets) to Radar (External Teams) on the Data-Engineering board.Feb 14 2024, 3:39 PM

Change 1004269 had a related patch set uploaded (by Alex Paskulin; author: Alex Paskulin):

[mediawiki/extensions/EventLogging@master] docs: Replace JSDuck with JSDoc

https://gerrit.wikimedia.org/r/1004269

gerritbot added a project: Patch-For-Review.Feb 17 2024, 12:58 AM

phuedx added a parent task: T357003: Fix public documentation for mw.eventLog.submit() and dispatch().Feb 20 2024, 1:07 PM

apaskulin updated the task description. (Show Details)Feb 22 2024, 1:15 AM

phuedx assigned this task to apaskulin.Feb 26 2024, 1:24 PM

phuedx added a project: Data Products (Data Products Sprint 10).

phuedx moved this task from Sprint Backlog to Code Review / Tech Input on the Data Products (Data Products Sprint 10) board.

phuedx moved this task from Code Review / Tech Input to Done on the Data Products (Data Products Sprint 10) board.Feb 27 2024, 11:14 AM

Change 1004269 merged by jenkins-bot:

[mediawiki/extensions/EventLogging@master] docs: Replace JSDuck with JSDoc

https://gerrit.wikimedia.org/r/1004269

Maintenance_bot removed a project: Patch-For-Review.Feb 27 2024, 12:30 PM

VirginiaPoundstone closed this task as Resolved.Apr 15 2024, 7:23 PM