Skip to content

Add handling for docs navigation file move

What does this MR do and why?

Updates lint-docs-redirects.rb to support the move of the docs website's navigation.yaml file. Moving that file into an en-us sub-directory is required for localizing the docs site.

This MR adds support for both the old and new location because we'll be moving the file via an MR in docs-gitlab-com (gitlab-org/technical-writing/docs-gitlab-com!307 (merged)), and that MR might merge at a different time than this MR.

Making this script support both navigation.yaml locations also allows us to more easily revert gitlab-org/technical-writing/docs-gitlab-com!307 (merged) if something doesn't work with it right away.

Once we've merged gitlab-org/technical-writing/docs-gitlab-com!307 (merged) and are confident it won't need to be reverted, we can drop the extra handling in this script for the old location.

References

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

Behavior should be unchanged. These should have the same results as they do on master:

  1. Should fail:
CI_PROJECT_PATH='gitlab-org/gitlab' CI_MERGE_REQUEST_IID=131392 scripts/lint-docs-redirects.rb
  1. Should pass:
CI_PROJECT_PATH='gitlab-org/gitlab' CI_MERGE_REQUEST_IID=171983 scripts/lint-docs-redirects.rb
Edited by Sarah German

Merge request reports

Loading