Skip to content

Lint against outdated docs links rendered with `HelpPageLink`

What does this MR do and why?

Lint against outdated docs links rendered with HelpPageLink

This adds a local ESLint rule to ensure documentation links rendered with the HelpPageLink Vue component are up-to-date.

This follows up on !159149 (merged) where we added an ESLint rule to catch outdated links generated with the helpPagePath Js helper. This basically does the same checks, but for the HelpPageLink component which is itself a wrapper around helpPagePath.

This also fixes the two violations this new rule found:

  • In ecfe7f28, the Change the linked namespace title was changed to Change the linked group in doc/subscriptions/gitlab_com/index.md, breaking an anchor link in the UI.
  • In c8dd4a4d, the Delayed refresh section was moved from doc/user/usage_quotas.md to doc/user/packages/container_registry/reduce_container_registry_storage.md, breaking a link in the UI.

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

Before After

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

Edited by Paul Gascou-Vaillancourt

Merge request reports