featzhang created FLINK-39643:
---------------------------------
Summary: [docs] Fix and improve MongoDB connector documentation
Key: FLINK-39643
URL: https://issues.apache.org/jira/browse/FLINK-39643
Project: Flink
Issue Type: Improvement
Components: Documentation
Reporter: featzhang
h2. Problem
Several issues were found in the MongoDB connector documentation under
{{docs/}}:
h3. Bug Fixes
* *[ZH DataStream]* The "Configurations" section header for MongoSink
incorrectly reads "Flink 的 MongoDB *Source* 可以通过
{{MongoSink.<InputType>builder()}} 构造器构建" — should be *Sink*.
* *[EN/ZH Table]* The default value for {{sink.delivery-guarantee}} is
documented as {{at-lease-once}} (typo) — should be {{at-least-once}}.
* *[EN DataStream]* Two sink configuration items ({{setOrderedWrites}} and
{{setBypassDocumentValidation}}) are both numbered "8." — duplicate numbering.
h3. Missing Content
* *[ZH DataStream]* Two sink options ({{setOrderedWrites}} and
{{setBypassDocumentValidation}}) present in the EN doc are missing from the ZH
doc entirely.
* *[ZH Table]* Two sink connector options ({{sink.ordered-writes}} and
{{sink.bypass-document-validation}}) present in the EN doc are missing from the
ZH doc.
* *[EN/ZH DataStream/Table]* The {{PAGINATION}} / {{pagination}} partition
strategy (which exists in code as {{PartitionStrategy.PAGINATION}}) is not
documented in any of the four files.
h3. Language Consistency
* *[ZH Table]* The "Dependencies" section is written in English inside an
otherwise Chinese document.
h3. Code Example Completeness
* *[EN/ZH DataStream]* The Source code example uses {{PartitionStrategy}} and
{{MemorySize}} without importing them. Added missing imports:
**
{{org.apache.flink.connector.mongodb.source.enumerator.splitter.PartitionStrategy}}
** {{org.apache.flink.configuration.MemorySize}}
h2. Changes
All four documentation files are updated:
* {{docs/content/docs/connectors/datastream/mongodb.md}}
* {{docs/content.zh/docs/connectors/datastream/mongodb.md}}
* {{docs/content/docs/connectors/table/mongodb.md}}
* {{docs/content.zh/docs/connectors/table/mongodb.md}}
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
