[PR] [GH-2867] Wire mkdocs-static-i18n for Chinese documentation [sedona]

["jiayuasu (via GitHub)" <gi...@apache.org>]

jiayuasu opened a new pull request, #2920:
URL: https://github.com/apache/sedona/pull/2920

   ## Summary
   
   Phase 1 of #2867 — wires up the `mkdocs-static-i18n` plugin so the docs site can serve a Chinese (`zh`) version alongside English. The default locale stays English and pages without a `*.zh.md` translation fall back to the English content automatically, so subsequent translation PRs can land incrementally per section.
   
   - Register `mkdocs-static-i18n` in the `docs` dependency group in `pyproject.toml`
   - Configure suffix-mode i18n in `mkdocs.yml` (`file.zh.md` next to `file.md`) with `reconfigure_material` and `reconfigure_search` so the language switcher appears in the header and search indexes both locales
   - Translate ~120 top-level navigation labels (Install, Programming Guide, API, Community, etc.) for the `zh` build via `nav_translations`
   - Seed `docs/index.zh.md` so the Chinese tree builds with content; future PRs translate the rest
   
   ## Rollout
   
   Translation lands as a series of follow-up PRs (#2909-#2919), one per documentation section, so each PR stays small and reviewable. See #2867 for the full checklist.
   
   ## Test plan
   
   - [x] `uv sync --group docs` installs `mkdocs-static-i18n` cleanly
   - [x] `uv run mkdocs build` succeeds; output reports `Translated 120 navigation elements to 'zh'`
   - [x] `site/` contains the English tree at root and a parallel `site/zh/` tree
   - [x] `site/index.html` contains `<link rel="alternate" hreflang="en">` and `hreflang="zh"` tags (language switcher wired)
   - [x] `site/zh/index.html` shows the Chinese announcement bullets from `index.zh.md`
   - [x] `site/zh/sedonaspark/index.html` falls back to the English content (since no `sedonaspark.zh.md` exists yet)
   - [x] `site/zh/index.html` navigation shows translated labels (e.g. "安装", "编程指南", "发布说明")
   
   ## Notes
   
   - The homepage hero strings live in `docs-overrides/main.html`, not in `index.md`, so they will appear in English on the `/zh/` homepage until Phase 2 (#2909) makes the template locale-aware.
   - Auto-generated content (R `pkgdown` under `api/rdocs`, Python Sphinx under `api/pydocs`, JavaDoc, ScalaDoc) stays English-only — those are produced from source comments, not Markdown.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@sedona.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [GH-2867] Wire mkdocs-static-i18n for Chinese documentation [sedona]

["jiayuasu (via GitHub)" <gi...@apache.org>]

jiayuasu merged PR #2920:
URL: https://github.com/apache/sedona/pull/2920


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@sedona.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org