[
https://issues.apache.org/jira/browse/FLINK-40951?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18124887#comment-18124887
]
Xiqian Yu commented on FLINK-40951:
-----------------------------------
[~sd4324530] Thank you for the nice proposal, assigned to you.
> Sync Chinese docs of Flink source connectors with English docs
> --------------------------------------------------------------
>
> Key: FLINK-40951
> URL: https://issues.apache.org/jira/browse/FLINK-40951
> Project: Flink
> Issue Type: Improvement
> Components: Flink CDC
> Reporter: peiyu
> Assignee: peiyu
> Priority: Major
> Labels: pull-request-available
>
> h3. Background
> The Chinese docs under {{docs/content.zh/docs/connectors/flink-sources/}} had
> drifted out
> of sync with the English docs:
> * several files were still untranslated;
> * sections and connector options newly added to the English docs were missing
> in Chinese;
> * terminology was inconsistent across files (e.g. "chunk" was translated
> variously as
> 分片 / 区块 / 块);
> * some translated files had Markdown formatting regressions (inline code
> written with
> triple backticks, lost bold/code formatting, dropped details from the
> English original).
> h3. What this change does
> * Translate all untranslated files and backfill missing sections/options to
> align with
> the current English docs (the {{tutorials/}} subdirectory is intentionally
> out of scope).
> * Normalize terminology across all files (chunk -> 分片, snapshot -> 快照, etc.),
> including the "Incremental Snapshot Reading" section of mysql-cdc.md and the
> corresponding anchor (#分片读取算法).
> * Fix inline code formatting: replace triple-backtick inline code with single
> backticks
> ({{scan.startup.mode}} in 7 connector files, {{0s}} in mysql-cdc.md).
> * Restore details dropped in translation: global read lock (FLUSH TABLES WITH
> READ LOCK),
> {{RELOAD}} permission inline code, bold formatting for "incremental
> snapshot algorithm".
> h3. Affected files
> 11 files under {{docs/content.zh/docs/connectors/flink-sources/}}:
> datastream-api-package-guidance.md, db2-cdc.md, mongodb-cdc.md, mysql-cdc.md,
> oceanbase-cdc.md, oracle-cdc.md, overview.md, postgres-cdc.md,
> sqlserver-cdc.md,
> tidb-cdc.md, vitess-cdc.md
> h3. Verification
> * Structural comparison EN vs ZH: heading levels, option tables (row/column
> counts and
> option names), code block counts and contents — all aligned, no missing
> options.
> * No untranslated paragraphs remain; external links are properly localized
> (e.g. Flink SQL Hints -> zh docs, OceanBase/Alibaba Cloud -> Chinese sites).
> * All internal localized anchors (e.g. #分片读取算法) resolve to existing headings.
> * Terminology scan confirms no mixed "chunk" translations remain across the
> 11 files.
> h3. Out of scope / known upstream issues
> * {{tutorials/}} is not translated in this pass.
> * Pre-existing triple-backtick inline code in the *English* docs
> (e.g. ```mysql-cdc```, ```Download link is available only for stable
> releases.```)
> is kept as-is in the Chinese docs to remain faithful to upstream; it should
> be fixed
> separately in the English docs.
> * The broken anchor {{#a-name-id-003-a}} in mongodb-cdc.md exists in both EN
> and ZH
> docs (upstream issue).
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
