Skip to content

Improve the efficiency of HelpPagePath link checker

What is the GitLab engineering productivity problem to solve?

Following the introduction of the helpPagePath eslint rule to check for broken links in the frontend, we should try to optimize it in the pipeline: Lint against outdated usages of `helpPagePath` (!159149 - merged)

The new test runs the full suite of eslint rules, including the graphql-schema-dump and generate-apollo-graphql-schema jobs, which are required for the full eslint suite of frontend lints, which is longer than the entire docs pipeline was before the addition of this check.

Problem identification checklist

  • The root cause of the problem is identified.
  • The surface of the problem is as small as possible.

What are the potential solutions?

We could:

  • Find a way to keep the same eslint configuration, but in docs-only pipelines use CLI flags to only run the require_valid_help_page_path rule.
  • Create a minimal separate eslint configuration file with just the require_valid_help_page_path rule, and use that to run the check in docs-only pipelines.
  • All potential solutions are listed.
  • A solution has been chosen for the first iteration: PUT THE CHOSEN SOLUTION HERE

Verify that the solution has improved the situation

  • The solution improved the situation.
    • If yes, check this box and close the issue. Well done! 🎉
    • Otherwise, create a new "Productivity Improvement" issue. You can re-use the description from this issue, but another solution should be chosen this time.
Edited by Amy Qualls