Skip to content

Add Hugo build tests to docs content pipelines

Docs content pipelines need to run a Hugo build as a test to validate shortcodes.

We also need to test file naming. The move to Hugo, and dropping the ee prefix for GitLab project paths, introduces a few potential problems caused by filenames:

  1. Index pages should be named _index.md rather than the standard index.md. Missing the underscore will cause sub-pages in this directory to not be built by Hugo (see https://gohugo.io/content-management/page-bundles/).

    • Possible solution: Add a check, probably in the lint-doc.sh script in the gitlab project, to make sure index files have the leading underscore.
  2. The gitlab project must not include top-level directories with the same names as the other projects (runner, charts, etc). Otherwise the gitlab page will be built, but not the page for the other project.

  3. Update projects to use the markdownlint image from the docs-gitlab-com project.

Done when

We will introduce these as manual jobs so that they don't slow down regular docs pipelines, then enable them to run on regular docs pipelines.

Edited by Sarah German