zhangshenghang opened a new pull request, #13234:
URL: https://github.com/apache/seatunnel/pull/13234
## Purpose of the change
This is a documentation-only change that fixes real documentation defects
found by auditing the docs against the source code on the current `dev` branch.
I am glad to contribute to Apache SeaTunnel.
## Documentation issues found and what was changed
**Connector option/doc vs code mismatches (verified in Java sources):**
- `docs/{en,zh}/connectors/sink/S3-Redshift.md`: the option table, section
heading and all three task examples documented a nonexistent option
`access_secret`. The connector reads the S3 credential from `secret_key`
(`S3FileBaseOptions.S3_SECRET_KEY`, `S3HadoopConf`); `access_secret` is the key
of the OSS/OBS connectors. Renamed to `secret_key` everywhere (the zh examples
already used `secret_key`, so the zh doc was internally inconsistent too).
- `docs/{en,zh}/connectors/sink/InfluxDB.md`: `write_timeout` is parsed into
`SinkConfig` but never applied by `InfluxDBClient`, so it is a no-op.
Documented it as deprecated/no-op with a pointer to
`connect_timeout_ms`/`query_timeout_sec`, and removed the misleading
`write_timeout = 10` from the example.
- `docs/{en,zh}/connectors/source/Vitess-CDC.md`: added the
`username`/`password` VTGate gRPC credential rows that exist in
`VitessSourceOptions` but were undocumented.
- `docs/{en,zh}/connectors/sink/Snowflake.md`: added the `generate_sink_sql`
option row (Boolean, default `false`, `JdbcSinkOptions.GENERATE_SINK_SQL`) that
the whole CDC/`MERGE` write path depends on but that was never defined in the
table.
- `docs/{en,zh}/connectors/source/GoogleAds.md`: documented
`api_endpoint`/`oauth_endpoint` (exist in `GoogleAdsSourceOptions` with
defaults).
- `docs/{en,zh}/connectors/source/FacebookAds.md`: documented `api_endpoint`
(exists in `FacebookAdsSourceOptions` with default).
**Missing option table:**
- `docs/{en,zh}/connectors/sink/Mem0.md`: the page had no option table at
all. Added one covering all options from `Mem0SinkOptions` with the required
flags (`api_key`, `messages_field`) from `Mem0SinkFactory.optionRule()` and the
`api_base_url` default.
**Broken/misleading examples and commands:**
- `docs/{en,zh}/connectors/sink/Clickhouse.md`: the FakeSource→Clickhouse
example used Kafka's port `9092`; changed to the ClickHouse HTTP port `8123`
used by all other examples in the same pages.
- `docs/{en,zh}/introduction/configuration/config-encryption-decryption.md`:
the encrypt/decrypt commands referenced a nonexistent template
`config/v2.batch.template`; changed to the shipped
`config/v2.batch.config.template`.
- `docs/{en,zh}/engines/flink.md`: "Running From A Source Checkout" pointed
to the nonexistent module
`seatunnel-examples/seatunnel-flink-connector-v2-example` and class
`org.apache.seatunnel.example.flink.v2.SeaTunnelApiExample`; replaced with the
real modules (`seatunnel-flink-{13,15,20}-example`) and entry points
(`SeaTunnelBatchJobExample`/`SeaTunnelStreamingJobExample`).
- `docs/zh/introduction/configuration/metalake.md`: the curl example was
missing `\` line continuations, so copying it would run each `-H` line as a
separate command; restored the continuations to match the English page.
**English/Chinese consistency:**
- `docs/zh/connectors/source/InfluxDB.md`: added the missing multi-table
`where` rejection paragraph (`tables_configs` entries fail at build time with
`OptionValidationException`) that the English page documents and
`InfluxDBSourceFactory` enforces.
**Spelling/grammar/outdated statements:**
- `docs/{en,zh}/connectors/source/MySQL-CDC.md`: `VARBINAR` → `VARBINARY` in
the type-mapping table; `/etc/inint.d/mysqld restart` → `/etc/init.d/mysqld
restart`.
- `docs/en/connectors/source/SqlServer-CDC.md`: fixed the garbled heading
"initiali read Simple" ("Initial Read Simple") and rewrote its garbled
one-sentence explanation into readable English.
- `docs/{en,zh}/introduction/concepts/connector-v2-features.md`: replaced
the outdated "Currently, Flink and Spark are supported, and we will support
other engines in the future" with the actual supported engine set including
SeaTunnel Engine (Zeta).
- `docs/zh/ai-cli/benchmark.md`: moved the page-intro paragraph from the
middle of the document back to directly under the H1, matching the English page
structure.
- `docs/zh/faq.md`: `${you_var}` → `${your_var}` in the multi-line
substitution example, consistent with the English page.
## Are English and Chinese docs both checked?
Yes. Every fix above was applied to both `docs/en` and `docs/zh` where both
versions exist; EN/ZH option tables were re-diffed row by row after the change.
One exception: `docs/zh/connectors/source/SqlServer-CDC.md` was intentionally
left untouched because it is already part of open PR #13149.
## How duplicate PRs from the last 7 days were checked
I listed all PRs created since 2026-11-04 in `apache/seatunnel` and
inspected the changed-file lists of every open docs PR by the same author and
others: #13216, #13204, #13193, #13149 (open), #13163, #13135 (merged), plus
the transform-rewrite PRs #13186/#13148. None of the 29 files touched here
appears in those PRs (verified again immediately before submitting; no new docs
PRs were opened in the meantime). Two candidate fixes found during the audit
were dropped because they were ambiguous or their premise did not hold on
re-verification (SLS `log_group_size` is parsed but also unused; the
engines-overview vs schema-evolution page conflict needs a product decision).
## How the change was verified
- Every option name, default, type and required marker in the changed tables
was cross-checked against the corresponding `*Options.java`/factory sources
(cited above).
- Scripted checks over all 29 modified files: markdown table column
consistency (all tables consistent), all relative links resolve, and zero
leftover occurrences of the wrong values (`VARBINAR`, `inint.d`,
`v2.batch.template`, `access_secret` in S3-Redshift, `9092` in Clickhouse
examples, old Flink example module/class).
- Verified the replacement Flink example modules/classes exist in the tree,
and that no inbound doc links target the renamed
`SqlServer-CDC.md`/`S3-Redshift.md` section anchors.
- No docs-site build exists in this repository (the Docusaurus site lives in
the separate `seatunnel-website` repo), so no site build was run; `./mvnw
verify` was not run because this PR touches no code.
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]