zhangshenghang opened a new pull request, #12409:
URL: https://github.com/apache/seatunnel/pull/12409

   ### Purpose of this pull request
   
   This PR fixes a batch of real documentation issues found by auditing 
connector docs against the connector source code, and syncs Chinese docs that 
had drifted behind their English counterparts.
   
   ### Issues found and what was changed
   
   **Accuracy fixes (docs vs. code)**
   1. **Http-Linear source doc was unreachable from the docs site and used a 
wrong plugin name.** The doc lived in the legacy, non-navigated directory 
`docs/en/connector-v2/source/` (`sidebars.js` only autogenerates 
`connectors/source` and `connectors/sink`), and its example block was named 
`Http-Linear`, which can never match the factory identifier `Linear` 
(`LinearSourceFactory.factoryIdentifier()`), so copying the example verbatim 
fails plugin discovery. The doc is moved to 
`docs/en/connectors/source/Http-Linear.md`, the example is fixed to `Linear`, 
and the previously missing option rows (`method`, `body`, `headers`, `params`, 
`format`, `schema`, `json_field`, `content_field`, `retry`, 
`retry_backoff_multiplier_ms`, `retry_backoff_max_ms`) are documented from 
`HttpSourceFactory`/`HttpCommonOptions`, matching the options the example 
itself uses. A missing `docs/zh` translation is added at the rendered path, and 
changelog files (`connector-http-linear.md`, en+zh) are created follow
 ing the same convention as #12378.
   2. **IoTDBv2 source/sink docs (en+zh) rendered the changelog of the old 
IoTDB 1.x connector.** All four docs imported 
`../changelog/connector-iotdb.md`. New `connector-iotdb-v2.md` changelog files 
(en+zh) are created from the `connector-iotdb-v2` module history (commits #9872 
→ 2.3.13, #11573/#11839 → dev) and the imports are repointed.
   3. **Mem0 sink docs (en+zh) had no option reference at all.** A Sink Options 
table is added, generated from `Mem0SinkOptions` and 
`Mem0SinkFactory.optionRule()`: required `api_key`, `messages_field`; optional 
`api_base_url` (default `https://api.mem0.ai`), scope fields, `retry` options 
with defaults 100/10000 ms.
   
   **Chinese docs synced with English docs (verified against en content)**
   
   4. `zh sink/HdfsFile.md`: added 6 option rows missing from the table 
(`sheet_max_rows` default 1048576, `xml_root_tag` RECORDS, `xml_row_tag` 
RECORD, `xml_use_attr_format`, `parquet_avro_write_timestamp_as_int96`, 
`parquet_avro_write_fixed_as_int96`) — verified against 
`FileBaseSinkOptions.java`.
   5. `zh sink/S3File.md`, `zh sink/OssFile.md`, `zh sink/SftpFile.md`, `zh 
sink/ObsFile.md`: added missing `filename_extension` and/or `sheet_max_rows` 
rows.
   6. `zh sink/Http.md`: added the missing "Multiple table" section (dynamic 
`${database_name}/${table_name}` and `${schema_name}/${table_name}` URL 
examples).
   7. `zh sink/Prometheus.md`: added the missing "Streaming Remote Write With 
Batched Flush" and "Multi-Table Remote Write" sections.
   8. `zh sink/AmazonSqs.md`: added the missing "Authentication" section 
(credential resolution order, LocalStack/ElasticMQ testing note).
   9. `zh source/SqlServer-CDC.md`: added the initial-snapshot behavior note in 
the description and the "Heartbeat action" recipe 
(`debezium.heartbeat.action.query` + `debezium.heartbeat.interval.ms`).
   10. `zh sink/GraphQL.md`: added the missing "Stream Mutations to a GraphQL 
Service" example.
   11. `zh source/InfluxDB.md`: added the `### where [string]` reserved-option 
explanation and the "Bounded Read With Parallel Splits" example.
   
   ### Scope
   
   24 files: 20 modified, 4 created (2 zh connector docs/changelog pairs). Both 
`docs/en` and `docs/zh` are covered by design — every content fix is applied to 
both languages.
   
   ### Duplicate-PR check (last 7 days)
   
   - Open PR **#12347** (same author, option defaults/malformed tables/broken 
links + zh Splunk doc) and **#12378** (moves FacebookAds/GoogleAds/Salesforce 
into `connectors/` + feature checklists) were reviewed file-by-file before 
starting; **no file touched by this PR overlaps either PR**. This PR 
intentionally follows #12378's move convention for the remaining legacy-dir doc 
(Http-Linear).
   - Open PR **#12276** adds a zh Http-Linear translation, but at the legacy 
non-rendered path `docs/zh/connector-v2/source/` and carrying over the broken 
`Http-Linear` plugin name. This PR supersedes that placement by providing the 
translation at the rendered path with the corrected plugin name; #12276 would 
create a duplicate page if merged as-is.
   - No other open or recent PR covers the IoTDBv2 changelog mis-import, the 
Mem0 option table, or the zh sync items above.
   
   ### Verification
   
   - A scripted check over all 23 changed markdown files: every relative link 
and `import ChangeLog` target resolves on disk, and every cross-file `#anchor` 
matches a heading in the target file — no broken links/anchors.
   - Markdown table integrity check (consistent column counts per table) — 
passes.
   - Every added/changed option row was cross-checked against the connector 
source (`LinearSourceFactory`, `HttpSourceFactory`, `HttpCommonOptions`, 
`Mem0SinkOptions`/`Mem0SinkFactory`, `FileBaseSinkOptions`) for 
name/type/default/required accuracy; changelog versions were derived from 
release tags with `git tag --contains`.
   - The full Docusaurus site build is not runnable from this repository (the 
site toolchain lives in the separate seatunnel-website repo), so the build 
itself was not executed; the checks above are the doc-scoped equivalents.
   


-- 
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]

Reply via email to