Skip to content

Add navigation check for entries with absolute paths

Evan Read requested to merge eread/add-navigation-check-for-absolute-paths into main

What does this MR do and why?

Add a test for attempts to add global navigations links with absolutely paths (begin with /) which do not work.

Closes #1640 (closed).

How to set up and validate locally

  1. Configure a local GitLab Docs environment: https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/doc/setup.md.
  2. Check out this branch.
  3. Run scripts/check-navigation.sh. There should be no errors.
  4. Add / to the start of any and multiple global navigation entries in content/_data/navigation.yaml. Run scripts/check-navigation.sh and there should be one error for every modified entry.
  5. Undo changes to content/_data/navigation.yaml.
  6. Run scripts/check-navigation.sh. There should be no errors.

Merge request acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Merge request reports