Skip to content

Add argo_translation.yml for continuous translation process

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

What does this MR do?

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 docs/ 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 (Charts, Operator, GitLab, and Omnibus)

Workflow:

  1. Argo tracks changes to docs/ directory from our production localization fork of GitLab Runner
  2. When MRs merge, Argo detects changes via GitLab Argo Integration webhook fork and determines files for translation
  3. Translated files return to our GitLab Runner 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 /docs-locale directory, which has been added to all projects

Configuration Details:

  • Source: English (en-us) → Target: Japanese (ja-jp)
  • Tracking: All Markdown in docs/ (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 Charts, Operator, GitLab, and Omnibus repositories.

For details, see GitLab Localization Documentation

To QA

  1. Verify this argo_translation.yml file here is identical to the version on our main-translation branch in our forked GitLab Runner project
  2. To verify yml formatting, you can pull this add-argo-translation-config branch down locally
  3. Make an edit to argo_translation.yml that is informal yml
  4. Run through the yaml:lint CI scripts manually to see argo_translation.yml through a error.
    • specifically, run this locally - prettier --check "*.{yml,yaml}" --log-level warn
    • this will enforce proper yml formatting and fail the pipeline if it is not.

Related issues

  1. Closes https://gitlab.com/gitlab-com/localization/docs-site-localization/-/issues/209
  2. Child of gitlab-com/localization&14
  3. Related GitLab MR
  4. Related Charts MR

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