Skip to content

Add argo_translation.yml for continuous translation process

Lauren Barkerrequested to merge
add-argo-translation-config into master

What does this MR do and why?

This MR adds the argo_translation.yml configuration file to enable our Japanese translation workflow for documentation.

Purpose:

  • Enables automated tracking of English content changes in the doc/ directory
  • Facilitates the translation process through our GitLab Argo Integration
  • Follows established pattern of placing translation configs at root (similar to crowdin.yml)
  • Part of comprehensive translation implementation across repositories (Runner, Operator, Charts, and Omnibus)

Workflow:

  1. Argo tracks changes to doc/ directory from our production localization fork
  2. When MRs merge, Argo detects changes via GitLab Argo Integration webhook fork and determines files for translation
  3. Translated files return to our fork with the gitlab-translation-service label. See them here.
  4. After review, translations merge to fork's main-translation branch
  5. Final translations delivered upstream to /doc-locale directory, which has been added to all projects

Configuration Details:

  • Source: English (en-us) → Target: Japanese (ja-jp)
  • Tracking: All Markdown in doc/ (excluding hidden directories)
  • Delivery: /doc-locale directory

This is the next step in establishing continuous translation of technical documentation across GitLab projects. Similar argo_translation.yml files will be added to Runner, Operator, Charts, and Omnibus repositories.

For details, see GitLab Localization Documentation

References

  1. Closes https://gitlab.com/gitlab-com/localization/docs-site-localization/-/issues/161
  2. Related https://gitlab.com/gitlab-com/localization/argo-gitlab-integration/-/issues/44
  3. Child of gitlab-com/localization&14

How to set up and validate locally

  1. Pull this branch down
  2. Make a change to argo_translation.yml that forces the yml to be invalid
  3. Run yamllint --strict -f colored argo_translation.yml locally to verify the error will be caught when the lint-yaml CI job runs

MR acceptance checklist

Evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Lauren Barker

Merge request reports