Skip to content

docs(vi): scaffold Vietnamese (vi-vn) translation — initial content for docs.github.com/vi - #46470

Closed
Dennis-nham wants to merge 8 commits into
github:mainfrom
Dennis-nham:feat/vi-translation-only
Closed

Dennis-nham wants to merge 8 commits into
github:mainfrom
Dennis-nham:feat/vi-translation-only

Conversation

@Dennis-nham

Copy link
Copy Markdown

🇻🇳 Vietnamese Translation — Initial Scaffolding for docs.github.com/vi

Submitter: NHAM QUOC HUAN · @nlp-labs-vietnam
Related discussion: Please see companion proposal in GitHub Docs Discussions (linked below)
Contact: enterprise@nlpgroup.vn


What this PR contributes

This PR adds the initial Vietnamese (vi-vn) translation scaffolding under translations/vi-vn/ — no src/ files are modified.

The language registration in src/languages/lib/languages.ts is intentionally omitted here; that change requires GitHub staff action and is proposed separately via a GitHub Docs Discussion.

Files added

File Content
translations/vi-vn/README.md Translation guide, Vietnamese glossary, contribution process
translations/vi-vn/content/index.md Landing page — docs.github.com/vi
translations/vi-vn/content/get-started/index.md "Bắt đầu với GitHub" section
translations/vi-vn/content/actions/get-started/quickstart.md ✅ Full translation of Quickstart for GitHub Actions
translations/vi-vn/data/ui.yml UI strings: header, footer, search, article feedback

Full translation sample: Quickstart for GitHub Actions

The file translations/vi-vn/content/actions/get-started/quickstart.md is a complete, production-ready Vietnamese translation of the Quickstart for GitHub Actions page. It demonstrates the translation quality and conventions the vi-vn team will maintain.

Translation conventions

Decision Rationale
Keep: GitHub Actions, workflow, runner, job, step, push, commit Industry-standard terms with no better Vietnamese equivalent; understood by all VN developers
Translate: all headings, prose, UI labels Accessibility for Vietnamese developers with limited English proficiency
Keep unchanged: code blocks, Liquid tags, YAML keys, frontmatter keys Must not be translated — would cause runtime errors
Update: /en/ → /vi/ in internal links Correct locale navigation
Translate: image alt text Screen reader accessibility

Sample comparison

English: "GitHub Actions is a continuous integration and continuous delivery (CI/CD) platform that allows you to automate your build, test, and deployment pipeline."

Vietnamese: "GitHub Actions là nền tảng tích hợp liên tục và phân phối liên tục (CI/CD) cho phép bạn tự động hóa quy trình build, kiểm thử và triển khai."


Why Vietnamese now?

Metric Data
Vietnamese GitHub users ~800,000+
Vietnamese speakers ~95M — same as German (already supported)
Vietnam tech growth +28% YoY (MOIT 2024)
SEA's fastest-growing developer market GitHub Octoverse 2023

Vietnamese is the only major language with 80M+ speakers in GitHub's current supported language set that does not have a docs.github.com/{code} endpoint.


Request for GitHub team action

To activate docs.github.com/vi, the GitHub Docs team would need to:

  1. Register vi in src/languages/lib/languages.ts (GitHub staff only)
  2. Create private translation repo github/docs-vi-vn (same model as docs-es-es, docs-ja-jp)
  3. Update CDN accept-language handling for vi

@nlp-labs-vietnam commits to:

  • Maintaining a core team of 3+ bilingual translators
  • Covering top 50 most-visited pages within 60 days of repo creation
  • Long-term maintenance of the vi-vn locale

Checklist

  • Only translations/vi-vn/ files modified (no src/, no content/ English files)
  • Follows existing translation directory structure (content/ + data/)
  • Full translation sample demonstrates quality (quickstart.md)
  • Vietnamese glossary documented for consistency
  • All Liquid tags and code blocks preserved unchanged
  • Internal links updated to /vi/ locale

@welcome

welcome Bot commented Oct 25, 2026

Copy link
Copy Markdown

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Oct 25, 2026
@github-actions

Copy link
Copy Markdown
Contributor

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

This pull request contains code changes, so we will not generate a table of review links.

🤖 This comment is automatically generated.

@Dennis-nham

Copy link
Copy Markdown
Author

📋 Language registration — request for GitHub Docs team

This PR intentionally excludes changes to src/languages/lib/languages.ts (per contribution guidelines). To activate docs.github.com/vi, the GitHub Docs team would need to apply the following change:

// src/languages/lib/languages.ts
// Add to LanguageCode type:
export type LanguageCode = 'en' | 'es' | 'ja' | 'pt' | 'zh' | 'ru' | 'fr' | 'ko' | 'de' | 'vi'

// Add to LocaleCode type:
| 'vi-vn'

// Add to languages map:
vi: {
  name: 'Vietnamese',
  nativeName: 'Tiếng Việt',
  code: 'vi',
  hreflang: 'vi',
  redirectPatterns: [/^\/vn/],
  locale: 'vi-vn',
  firstArchivedVersion: '3.12',
},

Additionally requesting:

  1. Creation of private translation repo github/docs-vi-vn
  2. CDN accept-language update for vi

@nlp-labs-vietnam is ready to maintain the vi-vn locale long-term. 🇻🇳

@Dennis-nham

Copy link
Copy Markdown
Author

📊 Cập nhật: thêm 3 bản dịch mới — tổng 4 trang hoàn chỉnh

Vừa push thêm 3 bản dịch tiếng Việt hoàn chỉnh vào branch này:

File dịch Trang gốc Độ ưu tiên
content/repositories/.../quickstart-for-repositories.md Quickstart for repositories ⭐ Top 5
content/get-started/git-basics/set-up-git.md Set up Git ⭐ Top 10
content/actions/get-started/understand-github-actions.md Understanding GitHub Actions ⭐ Top 10

Tổng cộng đã có 4 trang dịch hoàn chỉnh trong PR này — đủ để reviewer đánh giá chất lượng và tính nhất quán của vi-vn locale.

Tất cả bản dịch tuân theo nguyên tắc nhất quán:

  • ✅ Giữ nguyên: thuật ngữ kỹ thuật (workflow, runner, job, commit, push)
  • ✅ Dịch: prose, heading, UI label, mô tả
  • ✅ Giữ nguyên: code block, Liquid tag, YAML key
  • ✅ Cập nhật: /en/ → /vi/ trong internal links

@subatoi

subatoi commented Oct 26, 2026

Copy link
Copy Markdown
Contributor

@Dennis-nham Unfortunately, we can't accepted unsolicited translations of our docs—we already have a service in place–and we wouldn't integrate this into the service, so I'm going to close this out.

@subatoi subatoi closed this Oct 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

triage Do not begin working on this issue until triaged by the team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants