Page MenuHomePhabricator

Replace jsduck with JSDoc3 in CollaborationKit
Closed, ResolvedPublic

Description

  • make sure CI isn't broken (sign of an abandoned extension)
  • get JSDoc + jsdoc-wmf-theme installed, with npm run jsdoc working and /docs/js viewable
  • compare it to JSDuck site, make sure it's identical, fix anything as needed. check both left menu and homepage. homepage has some extra stuff on it that isn't in the left menu
  • create / make sure it has a readme, in markdown. make sure the readme links to the extension on mediawiki.org
  • switch JSDuck for JSDoc on doc.wikimedia.org (by switching npm run doc to jsdoc. after that it will deploy instantly and the cache will clear in an hour)
  • delete any remaining JSDuck code

Event Timeline

Change #1039653 had a related patch set uploaded (by Novem Linguae; author: Novem Linguae):

[mediawiki/extensions/CollaborationKit@master] JSDoc: initial setup

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

Change #1039658 had a related patch set uploaded (by Novem Linguae; author: Novem Linguae):

[mediawiki/extensions/CollaborationKit@master] JSDoc: fix missing class methods in /docs/

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

Change #1039663 had a related patch set uploaded (by Novem Linguae; author: Novem Linguae):

[mediawiki/extensions/CollaborationKit@master] JSDoc: fix some eslint warnings

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

Change #1039683 had a related patch set uploaded (by Novem Linguae; author: Novem Linguae):

[mediawiki/extensions/CollaborationKit@master] JSDoc: create readme

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

Novem_Linguae changed the task status from Stalled to Open.Jun 6 2024, 5:13 PM
Novem_Linguae updated the task description. (Show Details)

Change #1039653 merged by jenkins-bot:

[mediawiki/extensions/CollaborationKit@master] docs: initial setup

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

Change #1039658 merged by jenkins-bot:

[mediawiki/extensions/CollaborationKit@master] JSDoc: switch from JSDuck to JSDoc

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

Change #1039663 merged by jenkins-bot:

[mediawiki/extensions/CollaborationKit@master] JSDoc: fix some eslint warnings

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

Change #1039683 merged by Alex Paskulin:

[mediawiki/extensions/CollaborationKit@master] JSDoc: create readme

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

Novem_Linguae claimed this task.
Novem_Linguae updated the task description. (Show Details)