Page MenuHomePhabricator

Expose mediawiki/tools/api-testing doc on doc.wikimedia.org
Closed, ResolvedPublic

Description

mediawiki/tools/api-testing is quite nice and deserves to be highlighted on https://doc.wikimedia.org/

For now it just has a README.md file. That is probably a good start.

Maybe we can add JSDoc to the repository and publish the result to doc.wm.o ,?

Event Timeline

It looks like the repository already uses the jsdoc plugin and jsdoc-style comments (example), so this might be ready for doc.wikimedia.org? Let me know if there's anything I can do to help.

I have completely missed the previous reply b @apaskulin . Looks like we just need to add jsdoc as a dependency and provide a npm run doc script https://www.mediawiki.org/wiki/Continuous_integration/Entry_points#JavaScript_documentation and from there we can add the doc job in integration/config using:

zuul/layout.yaml
- name: mediawiki/tools/api-testing
  template:
    - name: node12-rundoc-docker
  publish:
    - generic-node12-docs-docker-publish

Which should publish the doc at https://doc.wikimedia.org/api-testing/master/ and we can then add to the frontpage via integration/docroot.git

I could not find a wiki page explaining how to introduce JSDoc on a repository, but I have found https://gerrit.wikimedia.org/r/c/jquery-client/+/626136 I have asked further information on the legendary task that aims to replace jsduck by jsdoc: T138401#7138812

Change 698562 had a related patch set uploaded (by Hashar; author: Hashar):

[mediawiki/tools/api-testing@master] Add JSDoc

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

Change 698563 had a related patch set uploaded (by Hashar; author: Hashar):

[integration/config@master] api-testing: add npm run doc and publishing

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

Change 698564 had a related patch set uploaded (by Hashar; author: Hashar):

[integration/docroot@master] Add mediawiki/tools/api-testing JSDoc

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

hashar moved this task from Backlog to Repo setup on the Continuous-Integration-Config board.

JSDoc is introduced by: https://gerrit.wikimedia.org/r/c/mediawiki/tools/api-testing/+/698562 . I am not familiar with it though so I have merely copy pasted from another repository.

https://gerrit.wikimedia.org/r/c/integration/docroot/+/698564 would add a link on https://doc.wikimedia.org/ and most probably needs some tweaking.

hashar triaged this task as Medium priority.Jun 7 2021, 3:46 PM

Change 698563 merged by jenkins-bot:

[integration/config@master] Zuul: [mediawiki/tools/api-testing] Add npm run doc and publishing

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

Mentioned in SAL (#wikimedia-releng) [2021-06-14T16:31:15Z] <James_F> Zuul: [mediawiki/tools/api-testing] Add npm run doc and publishing T236915

Change 698562 merged by jenkins-bot:

[mediawiki/tools/api-testing@master] Add JSDoc

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

Change 698564 merged by jenkins-bot:

[integration/docroot@master] Add mediawiki/tools/api-testing JSDoc

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

Mentioned in SAL (#wikimedia-operations) [2021-06-14T16:46:31Z] <jforrester@deploy1002> Started deploy [integration/docroot@ca7af97]: Add mediawiki/tools/api-testing JSDoc to doc.wikimedia for T236915

Mentioned in SAL (#wikimedia-operations) [2021-06-14T16:46:39Z] <jforrester@deploy1002> Finished deploy [integration/docroot@ca7af97]: Add mediawiki/tools/api-testing JSDoc to doc.wikimedia for T236915 (duration: 00m 07s)

Change 699779 had a related patch set uploaded (by Jforrester; author: Jforrester):

[integration/config@master] Zuul: [mediawiki/tools/api-testing] Publish docs on postmerge

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

Change 699779 merged by jenkins-bot:

[integration/config@master] Zuul: [mediawiki/tools/api-testing] Publish docs on postmerge

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

Mentioned in SAL (#wikimedia-releng) [2021-06-14T16:57:26Z] <James_F> uul: [mediawiki/tools/api-testing] Publish docs on postmerge T236915

Change 699780 had a related patch set uploaded (by Jforrester; author: Jforrester):

[integration/docroot@master] Follow-up ca7af9764: Actually add api-testing's JSDoc, not just code link

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

Change 699780 merged by jenkins-bot:

[integration/docroot@master] Follow-up ca7af9764: Actually add api-testing's JSDoc, not just code link

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

Mentioned in SAL (#wikimedia-operations) [2021-06-14T17:05:02Z] <jforrester@deploy1002> Started deploy [integration/docroot@22061b6]: Actually add mediawiki/tools/api-testing JSDoc to doc.wikimedia for T236915

Mentioned in SAL (#wikimedia-operations) [2021-06-14T17:05:09Z] <jforrester@deploy1002> Finished deploy [integration/docroot@22061b6]: Actually add mediawiki/tools/api-testing JSDoc to doc.wikimedia for T236915 (duration: 00m 07s)

Thank you @apaskulin for testing the change and @Jdforrester-WMF for the approvals! 8-)

One less old task, a few thousands left to complete :-]