Page MenuHomePhabricator

Contribute link is unspecified and doesn't throw error
Closed, ResolvedPublic

Description

The footer of the theme has a Contribute link.

Most current jsdoc projects seem to have this as an empty link, because env.conf.templates.wmf.repository is not set. I think we shouldn't output an empty link if that value is not provided, and I also think we should make it so that jsdoc generation throws a warning if that template variable isn't set.

Project with a working Contribute link: https://doc.wikimedia.org/unicodejs/master/js/


Acceptance criteria

  • Make sure core has a working "contribute" link
  • Only output the link if env.conf.templates.wmf.repository is set
  • Throw a warning on build if it's not set

Event Timeline

apaskulin triaged this task as Medium priority.Dec 19 2023, 11:46 PM
apaskulin updated the task description. (Show Details)
apaskulin moved this task from Backlog to Confirmed Problem on the JSDoc WMF theme board.

Change 1008548 had a related patch set uploaded (by Anne Tomasevich; author: Anne Tomasevich):

[mediawiki/core@master] docs: Set JSDoc "Contribute" link to the core repo

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

Change 1008548 merged by jenkins-bot:

[mediawiki/core@master] docs: Set JSDoc "Contribute" link to the core repo

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

Change #1026820 had a related patch set uploaded (by Esanders; author: Esanders):

[jsdoc/wmf-theme@master] Don't render contribute link when no URL available, and print warning

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

Change #1026820 merged by jenkins-bot:

[jsdoc/wmf-theme@master] Don't render contribute link when no URL available, and print warning

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

TheDJ assigned this task to Esanders.
TheDJ awarded a token.
apaskulin subscribed.

Released as part of v1.0.1