Skip to content

Combine docs patterns to include i18n

What does this MR do?

Combining docs-patterns and docs-i18n-patterns Rules

This MR combines the .docs-patterns and .docs-i18n-patterns rules to address a downstream CI pipeline issue.

Problem

Changes in the /doc-locale directory aren't being captured by the .rules:docs:skip rule, causing the binaries CI job to fail downstream in our production fork of the GitLab Runner project.

Solution

By combining these rules to properly include our /doc-locale directory and lint-i18n script, we will:

  • Skip the binaries job downstream, resulting in green pipelines
  • Standardize pipeline rules for both documentation and localization contributions

This creates consistent behavior between docs and docs-locale updates.

Related issues

Related https://gitlab.com/gitlab-com/localization/docs-site-localization/-/issues/208

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
Edited by Lauren Barker

Merge request reports

Loading