Skip to content

Create the `Gitlab/DocumentationLinks/Link` cop

Paul Gascou-Vaillancourt requested to merge rubocop-ensure-valid-help-page-path into master

What does this MR do and why?

Create the Gitlab/DocumentationLinks/Link cop

This creates a cop that ensures that help_page_path usages link to existing documentation. As the documentation gets updated, it's easy to forget that we link to it from many parts of the product. Those links can get outdated as documentation files are removed, section moved around, titles changed, etc. This cop should ensure the product links stay in sync with the documentation.

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.

How to set up and validate locally

  1. Run the cop:

    rubocop {.,./ee}/app --only Gitlab/DocumentationLinks/Link --cache false
Edited by Peter Leitzen

Merge request reports