Skip to content

Implement custom compilation rules

Sarah German requested to merge 24-skip-pages into main

What does this MR do and why?

Adds handling for files we do not want to publish to the website, or process in our migration scripts.

Warnings from these pages (e.g invalid YAML) are not actionable, so let's keep them out of our logs in order to more easily spot actionable issues.

Screenshots, screen recordings, or links to review app

Migration scripts:

Hugo build no longer includes the non-docs docs:

Before After
image image

How to set up and validate locally

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

  1. Configure a local GitLab Docs environment: https://gitlab.com/gitlab-org/technical-writing-group/gitlab-docs-hugo/-/blob/main/doc/setup.md.
  2. Visit a page that is now ignored, like:

These should now return a 404.

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.

Closes #24 (closed)

Edited by Sarah German

Merge request reports