Skip to content

[GH-2910] Translate Setup / Install section to Chinese#2924

Merged
jiayuasu merged 1 commit intoapache:masterfrom
jiayuasu:feature/docs-i18n-setup
May 8, 2026
Merged

[GH-2910] Translate Setup / Install section to Chinese#2924
jiayuasu merged 1 commit intoapache:masterfrom
jiayuasu:feature/docs-i18n-setup

Conversation

@jiayuasu
Copy link
Copy Markdown
Member

@jiayuasu jiayuasu commented May 8, 2026

Did you read the Contributor Guide?

Is this PR related to a ticket?

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.md files alongside the English originals:

  • Top-level Setup pages: overview, modules, platform, install-scala, install-python, zeppelin, cluster, maven-coordinates, docker, compile
  • Cloud-platform install guides: wherobots, databricks, emr, glue, fabric, azure-synapse-analytics
  • Flink subdirectory: flink/install-scala, flink/install-python, flink/modules, flink/platform
  • Snowflake subdirectory: snowflake/install, snowflake/modules

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.

How was this patch tested?

Built the docs locally with uv sync --group docs && uv run mkdocs build and verified:

  • The build succeeds.
  • 22 new *.zh.md files are picked up by mkdocs-static-i18n and rendered under /zh/setup/ (and /zh/setup/flink/, /zh/setup/snowflake/).
  • Untranslated pages (e.g. /zh/setup/release-notes/) still fall back to the English content via fallback_to_default: true.
  • Spot-checked rendered pages: code blocks, version macros, and admonitions render identically to the English version; prose appears in Chinese.

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?

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.
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 main docs/setup/ install/setup guides.
  • Added Chinese (*.zh.md) pages for docs/setup/flink/ and docs/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.

Comment thread docs/setup/docker.zh.md
示例 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 }}
Comment on lines +43 to +48
./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 }}
Comment on lines +64 to +73
请使用文件名中包含 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
Comment on lines +69 to +73
.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 }},"
Comment thread docs/setup/emr.zh.md
Comment on lines +20 to +26
在 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 的版本后缀。

Comment thread docs/setup/fabric.zh.md
%%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
Comment thread docs/setup/cluster.zh.md
## 前置准备

1. 在集群上配置免密 SSH。每对 master-worker 之间需要双向免密 SSH。
2. 确保已安装 JRE 1.8 或更高版本。
Comment on lines +82 to +83
"org.apache.sedona:sedona-spark-shaded-3.4_2.12-1.6.1,"
"org.datasyslab:geotools-wrapper-1.6.1-28.2",
@jiayuasu
Copy link
Copy Markdown
Member Author

jiayuasu commented May 8, 2026

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 master:

Comment Same issue in English source
docker.zh.md:71 stray -e docs/setup/docker.md:71
install-scala.zh.md:48,73 Spark 3.3 example docs/setup/install-scala.md:43,68
install-python.zh.md:73,98 Spark 3.3 example docs/setup/install-python.md:71,97
emr.zh.md:26 EMR 6.9.0 / Spark 3.3.0 docs/setup/emr.md:20
fabric.zh.md:131 trailing comma in JSON docs/setup/fabric.md:131
flink/install-python.zh.md:25 attr should be attrs docs/setup/flink/install-python.md:25
cluster.zh.md:27 JRE 1.8 vs current Java 11+ requirement docs/setup/cluster.md:27
azure-synapse-analytics.zh.md:83 malformed Maven coordinates docs/setup/azure-synapse-analytics.md:82-83

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.

@jiayuasu jiayuasu merged commit 7f2efd9 into apache:master May 8, 2026
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[GH-2867] Translate Setup / Install section to Chinese (Phase 3)

2 participants