Cite js docs should be published to doc.wikimedia.org
Closed, ResolvedPublic
Actions

Description

As can be seen in the index, Cite source docs are not being published. For example, here are the VisualEditor source docs.

Add glue to this repo so that npm run doc generates docs/js/, and adjust CI configuration to publish.

Outcome

Main docs portal links to Cite: https://doc.wikimedia.org/
Cite js docs are automatically published from CI: https://doc.wikimedia.org/Cite/master/js/js/
Cite docs landing page is very gross, for some reason it's showing ext.cite.tracking.js . Follow-up recommended.

Details

Subject	Repo	Branch	Lines +/-
Clean up top-level docs	mediawiki/extensions/Cite	master	+11 -11
Link to Cite docs	integration/docroot	master	+4 -0
Clean up and fix some jsdoc annotations	mediawiki/extensions/Cite	master	+103 -100
Link to external docs	mediawiki/extensions/Cite	master	+35 -0
Zuul: [mediawiki/extensions/Cite] Publish JS docs post-merge	integration/config	master	+1 -0
Initial support for generating jsdoc	mediawiki/extensions/Cite	master	+506 -1

Customize query in gerrit

Event Timeline

awight created this task.Feb 28 2024, 7:51 AM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptFeb 28 2024, 7:51 AM

awight added projects: Unplanned-Sprint-Work, WMDE-TechWish-Sprint-2024-02-15.Feb 28 2024, 8:17 AM

Change 1007261 had a related patch set uploaded (by Awight; author: Awight):

[mediawiki/extensions/Cite@master] Initial support for generating jsdoc

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

Change 1007262 had a related patch set uploaded (by Awight; author: Awight):

[integration/config@master] Publish docs for Cite

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

awight moved this task from Sprint Backlog to Tech Review on the WMDE-TechWish-Sprint-2024-02-15 board.Feb 28 2024, 8:23 AM

awight updated the task description. (Show Details)

Change 1007264 had a related patch set uploaded (by Awight; author: Awight):

[mediawiki/extensions/Cite@master] Clean up and fix some jsdoc annotations

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

Change 1007265 had a related patch set uploaded (by Awight; author: Awight):

[integration/docroot@master] Link to Cite docs

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

Change 1007288 had a related patch set uploaded (by Awight; author: Awight):

[mediawiki/extensions/Cite@master] Link to external docs

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

thiemowmde renamed this task from Cite js docs should be published to doc.wmo to Cite js docs should be published to doc.wikimedia.org.Feb 28 2024, 9:35 AM

thiemowmde assigned this task to awight.

thiemowmde added a project: Documentation.

thiemowmde added subscribers: thiemowmde, WMDE-Fisch.

Change 1007261 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Initial support for generating jsdoc

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

WMDE-Fisch added a project: WMDE-TechWish-Sprint-2024-02-28.Feb 28 2024, 12:17 PM

WMDE-Fisch moved this task from Sprint Backlog to Tech Review on the WMDE-TechWish-Sprint-2024-02-28 board.

Change 1007262 merged by jenkins-bot:

[integration/config@master] Zuul: [mediawiki/extensions/Cite] Publish JS docs post-merge

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

Mentioned in SAL (#wikimedia-releng) [2024-02-28T14:10:30Z] <James_F> Zuul: [mediawiki/extensions/Cite] Publish JS docs post-merge for T358641

ReleaseTaggerBot added a project: MW-1.42-notes (1.42.0-wmf.21; 2024-03-05).Feb 28 2024, 5:01 PM

Change 1007288 abandoned by WMDE-Fisch:

[mediawiki/extensions/Cite@master] Link to external docs

Reason:

Merged into Iaee1dadcc19a70c27839d0d27dfa6a07a70fb46b

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

Change 1007264 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Clean up and fix some jsdoc annotations

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

awight moved this task from Tech Review to Done on the WMDE-TechWish-Sprint-2024-02-28 board.Mar 11 2024, 9:49 AM

Change 1007265 merged by jenkins-bot:

[integration/docroot@master] Link to Cite docs

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

Mentioned in SAL (#wikimedia-operations) [2024-03-12T06:35:30Z] <hashar@deploy2002> Started deploy [integration/docroot@a13474b]: Link to Cite docs - T358641

Mentioned in SAL (#wikimedia-operations) [2024-03-12T06:35:37Z] <hashar@deploy2002> Finished deploy [integration/docroot@a13474b]: Link to Cite docs - T358641 (duration: 00m 06s)

Maintenance_bot removed a project: Patch-For-Review.Mar 12 2024, 7:30 AM

awight removed awight as the assignee of this task.Mar 12 2024, 7:48 AM

awight updated the task description. (Show Details)

Change 1010485 had a related patch set uploaded (by Awight; author: Awight):

[mediawiki/extensions/Cite@master] Clean up top-level docs

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

gerritbot added a project: Patch-For-Review.Mar 12 2024, 8:41 AM

Change 1010485 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Clean up top-level docs

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

ReleaseTaggerBot edited projects, added MW-1.42-notes (1.42.0-wmf.23; 2024-03-19); removed MW-1.42-notes (1.42.0-wmf.21; 2024-03-05).Mar 12 2024, 1:00 PM

Maintenance_bot removed a project: Patch-For-Review.Mar 12 2024, 1:30 PM