[GH-2910] Translate Setup / Install section to Chinese#2924
[GH-2910] Translate Setup / Install section to Chinese#2924jiayuasu merged 1 commit intoapache:masterfrom
Conversation
Phase 3 of apache#2867. Adds Chinese (zh) translations for the entire Setup section so /zh/setup/ renders in Chinese on the docs site. 22 sibling *.zh.md files alongside the English originals. Top-level Setup pages (overview, modules, platform, install-scala, install-python, zeppelin, cluster, maven-coordinates, docker, compile) plus all cloud-platform install guides (wherobots, databricks, emr, glue, fabric, azure-synapse-analytics) and the Flink and Snowflake subdirectories. The release-notes page is intentionally deferred to a follow-up PR: its 2,300+ lines are mostly GitHub issue/PR bullets where the descriptive value of translation is low and the maintenance burden is high (every release would need both versions kept in sync). Code blocks, command snippets, version macros ({{ sedona.current_version }}, {{ sedona.current_geotools }}), and admonition syntax are preserved verbatim. Only prose, headings, table headers, and inline comments are translated. Some `[link](../page.md#english-anchor)` references in already-translated pages produce INFO log lines about missing anchors in the new zh files (the Chinese headings auto-generate Chinese anchors). Pages still resolve; only the in-page jump is lost. Establishing stable explicit anchors (`## Title { #stable-anchor }`) on translated headings is a separate cross-cutting concern best handled across all phases at once.
There was a problem hiding this comment.
Pull request overview
This PR is part of the Chinese documentation EPIC and adds zh translations for the Setup / Install section so the MkDocs i18n build can render /zh/setup/ (including Flink and Snowflake sub-sections) in Chinese.
Changes:
- Added Chinese (
*.zh.md) sibling pages for all maindocs/setup/install/setup guides. - Added Chinese (
*.zh.md) pages fordocs/setup/flink/anddocs/setup/snowflake/setup/install content. - Preserved existing code blocks/macros/admonition syntax while translating prose and headings.
Reviewed changes
Copilot reviewed 22 out of 22 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/setup/azure-synapse-analytics.zh.md | Chinese translation for Azure Synapse Analytics installation guide |
| docs/setup/cluster.zh.md | Chinese translation for Spark cluster setup guide |
| docs/setup/compile.zh.md | Chinese translation for “Compile Sedona” guide |
| docs/setup/databricks.zh.md | Chinese translation for Databricks installation guide |
| docs/setup/docker.zh.md | Chinese translation for Docker image usage/build guide |
| docs/setup/emr.zh.md | Chinese translation for AWS EMR installation guide |
| docs/setup/fabric.zh.md | Chinese translation for Microsoft Fabric installation guide |
| docs/setup/flink/install-python.zh.md | Chinese translation for Flink Python install guide |
| docs/setup/flink/install-scala.zh.md | Chinese translation for Flink Scala/Java install guide |
| docs/setup/flink/modules.zh.md | Chinese translation for Flink modules overview |
| docs/setup/flink/platform.zh.md | Chinese translation for Flink platform compatibility matrix |
| docs/setup/glue.zh.md | Chinese translation for AWS Glue installation guide |
| docs/setup/install-python.zh.md | Chinese translation for Spark Python install guide |
| docs/setup/install-scala.zh.md | Chinese translation for Spark Scala install guide |
| docs/setup/maven-coordinates.zh.md | Chinese translation for Maven coordinates reference |
| docs/setup/modules.zh.md | Chinese translation for Spark modules overview |
| docs/setup/overview.zh.md | Chinese translation for Setup overview (download stats + capabilities) |
| docs/setup/platform.zh.md | Chinese translation for Spark platform compatibility matrix |
| docs/setup/snowflake/install.zh.md | Chinese translation for Snowflake manual install guide |
| docs/setup/snowflake/modules.zh.md | Chinese translation for Snowflake modules overview |
| docs/setup/wherobots.zh.md | Chinese translation for WherobotsDB overview |
| docs/setup/zeppelin.zh.md | Chinese translation for Zeppelin plugin/install guide |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 示例 2: | ||
|
|
||
| ```bash | ||
| docker run -d -e -p 8888:8888 -p 8080:8080 -p 8081:8081 -p 4040:4040 -p 8085:8085 apache/sedona:{{ sedona.current_version }} |
| ./bin/spark-shell --packages org.apache.sedona:sedona-spark-shaded-3.3_2.12:{{ sedona.current_version }},org.datasyslab:geotools-wrapper:{{ sedona.current_geotools }} | ||
| ``` | ||
|
|
||
| * 集群模式:需要指定 Spark Master IP | ||
| ``` | ||
| ./bin/spark-shell --master spark://localhost:7077 --packages org.apache.sedona:sedona-spark-shaded-3.3_2.12:{{ sedona.current_version }},org.datasyslab:geotools-wrapper:{{ sedona.current_geotools }} |
| 请使用文件名中包含 Spark major.minor 版本号的 jar,例如 `sedona-spark-shaded-3.3_2.12-{{ sedona.current_version }}`。 | ||
|
|
||
| * 本地模式:无需搭建集群即可测试 Sedona | ||
| ``` | ||
| ./bin/spark-shell --jars /path/to/sedona-spark-shaded-3.3_2.12-{{ sedona.current_version }}.jar,/path/to/geotools-wrapper-{{ sedona.current_geotools }}.jar | ||
| ``` | ||
|
|
||
| * 集群模式:需要指定 Spark Master IP | ||
| ``` | ||
| ./bin/spark-shell --master spark://localhost:7077 --jars /path/to/sedona-spark-shaded-3.3_2.12-{{ sedona.current_version }}.jar,/path/to/geotools-wrapper-{{ sedona.current_geotools }}.jar |
| .config( | ||
| "spark.jars.packages", | ||
| "org.apache.sedona:sedona-spark-3.3_2.12:{{ sedona.current_version }}," | ||
| "org.datasyslab:geotools-wrapper:{{ sedona.current_geotools }}", | ||
| ) |
| .config("spark.kryo.registrator", SedonaKryoRegistrator.getName) | ||
| .config( | ||
| "spark.jars.packages", | ||
| "org.apache.sedona:sedona-spark-shaded-3.3_2.12:{{ sedona.current_version }}," |
| 在 EMR 上推荐使用 Sedona-1.3.1-incubating 及以上版本。本教程使用 AWS Elastic MapReduce (EMR) 6.9.0,已预装以下应用:Hadoop 3.3.3、JupyterEnterpriseGateway 2.6.0、Livy 0.7.1、Spark 3.3.0。 | ||
|
|
||
| 本教程在带 EMR Studio(notebook)的 EMR on EC2 上完成测试。EMR on EC2 使用 YARN 进行资源管理。 | ||
|
|
||
| !!!note | ||
| 如果您使用 Spark 3.4+ 与 Scala 2.12,请使用 `sedona-spark-shaded-3.4_2.12`。请注意 Spark 与 Scala 的版本后缀。 | ||
|
|
| %%configure -f | ||
| { | ||
| "conf": { | ||
| "spark.jars": "abfss://XXX/Files/sedona-spark-shaded-3.4_2.12-1.5.1.jar,abfss://XXX/Files/geotools-wrapper-1.5.1-28.2.jar", |
| 1. 安装所需的 Python 包。 | ||
|
|
||
| ``` | ||
| pip install apache-sedona[flink] shapely attr |
| ## 前置准备 | ||
|
|
||
| 1. 在集群上配置免密 SSH。每对 master-worker 之间需要双向免密 SSH。 | ||
| 2. 确保已安装 JRE 1.8 或更高版本。 |
| "org.apache.sedona:sedona-spark-shaded-3.4_2.12-1.6.1," | ||
| "org.datasyslab:geotools-wrapper-1.6.1-28.2", |
|
All 10 Copilot comments flag pre-existing issues in the English source documents, not bugs in the translation. The Chinese versions in this PR faithfully preserve the English content verbatim (modulo translated prose), so each issue exists identically in both files. Verified against
The scope of this PR is translation only. Fixing these in the Chinese files alone would let the two locales drift apart — the next person regenerating the English source would re-introduce the discrepancy. They're better addressed in a separate follow-up PR that updates both EN and ZH copies together (and the parallel install/setup pages can be audited as a unit while we're at it). Happy to open that follow-up PR after this one merges if it's helpful. |
Did you read the Contributor Guide?
Is this PR related to a ticket?
[GH-XXX] my subject. Closes [GH-2867] Translate Setup / Install section to Chinese (Phase 3) #2910, part of EPIC Add Chinese version of the documentation #2867.What changes were proposed in this PR?
Phase 3 of the Chinese-documentation EPIC (#2867). Adds Chinese (
zh) translations for the entire Setup / Install section so/zh/setup/renders in Chinese on the docs site.22 sibling
*.zh.mdfiles alongside the English originals:overview,modules,platform,install-scala,install-python,zeppelin,cluster,maven-coordinates,docker,compilewherobots,databricks,emr,glue,fabric,azure-synapse-analyticsflink/install-scala,flink/install-python,flink/modules,flink/platformsnowflake/install,snowflake/modulesThe
release-notespage is intentionally deferred to a follow-up PR. Its 2,300+ lines are mostly GitHub issue/PR bullets where the descriptive value of translation is low and the maintenance burden is high (every release would need both versions kept in sync).Code blocks, command snippets, version macros (
{{ sedona.current_version }},{{ sedona.current_geotools }}), and admonition syntax are preserved verbatim. Only prose, headings, table headers, and inline comments are translated.How was this patch tested?
Built the docs locally with
uv sync --group docs && uv run mkdocs buildand verified:*.zh.mdfiles are picked up bymkdocs-static-i18nand rendered under/zh/setup/(and/zh/setup/flink/,/zh/setup/snowflake/)./zh/setup/release-notes/) still fall back to the English content viafallback_to_default: true.Some
[link](../page.md#english-anchor)references in already-translated pages from earlier phases produce INFO log lines about missing anchors in the new zh files (the Chinese headings auto-generate Chinese anchors). The pages still resolve; only the in-page jump is lost. Establishing stable explicit anchors (## Title { #stable-anchor }) on translated headings is a separate cross-cutting concern best handled across all phases at once.Did this PR include necessary documentation updates?