Page MenuHomePhabricator

Description errors
Open, Needs TriagePublic

Description

A few findings from trying to use JSDoc Wikimedia Foundation theme:

  • Description says npm run docs while it's currently npm run doc. Grunt uses 'doc'. We should go with the common use case of big repos
  • Description differs from README.md to workboard. It would be better to put a reference into Phab workboard description than duplicating (and deriving from each other)
  • grunt doc results after following the steps in error ENOENT: no such file or directory, scandir '…/jsdoc-test/wmf-theme/WikimediaUI-Style-Guide/css/build'

Event Timeline

Volker_E created this task.Nov 14 2018, 6:40 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptNov 14 2018, 6:40 PM
Volker_E updated the task description. (Show Details)Nov 14 2018, 6:42 PM

Thanks for pointing out these issues @Volker_E. I've fixed the typos and updated the clone command to include the submodules. Can you try and test again?

Also, I didn't understand your comment about the README, could you elaborate?

Meant, that workboard description and README.md of the wmf-theme differ. I would dump the workboard description and mostly only point to latter as those places got left behind until the next person is possibly frustrated.

The description on the Phab workboard works exactly like described now 👍🏻

Meant, that workboard description and README.md of the wmf-theme differ. I would dump the workboard description and mostly only point to latter as those places got left behind until the next person is possibly frustrated.

I agree. I used this as a temporary place for two reasons:

  1. The patch on OOjs core isn't merged yet, and the current instructions include downloading a patch. I don't think that is appropriate for a README or CONTRIBUTING
  2. I need a temporary page to point the GCI students so that they can set up the thing.

I'll move it to the README as soon as the patch gets merged 😊