Skip to content

Add docs job to test Hugo build

Sarah Germanrequested to merge
sarahgerman-docs-site-hugo-tests into master

What does this MR do?

Two CI updates to support the GitLab Docs move to Hugo:

  1. Start using the lint-markdown Docker image from the new Docs website project for Docs lint jobs. This is Docker image is same as the one in gitlab-docs (source), but might have different specific versions of tools at this time.

    Jobs that use this image are working as expected:

  2. Add a new job to run a test Hugo build: https://gitlab.com/gitlab-org/cloud-native/gitlab-operator/-/jobs/9065945315

    This tests:

    • Can the site build, and do we have path clashes?
      • Invalid shortcode markup will cause this to fail.
    • Are there any files named index.md? The Hugo site expects index pages to all be named _index.md (read more).

Checklist

See Definition of done.

For anything in this list which will not be completed, please provide a reason in the MR discussion.

Required

  • Merge Request Title and Description are up to date, accurate, and descriptive
  • MR targeting the appropriate branch
  • MR has a green pipeline on GitLab.com
  • When ready for review, MR is labeled "~workflow::ready for review" per the Distribution MR workflow

Expected (please provide an explanation if not completing)

  • Test plan indicating conditions for success has been posted and passes
  • Documentation created/updated
  • Tests added
  • Integration tests added to GitLab QA
  • Equivalent MR/issue for omnibus-gitlab opened
  • Validate potential values for new configuration settings. Formats such as integer 10, duration 10s, URI scheme://user:passwd@host:port may require quotation or other special handling when rendered in a template and written to a configuration file.

Related issues

Edited by Hossein Pursultani

Merge request reports