flink icon indicating copy to clipboard operation
flink copied to clipboard

[FLINK-34250] add config docs for formats

Open HuangZhenQiu opened this issue 1 year ago • 2 comments

What is the purpose of the change

Generate the doc sections for Flink format options.

Brief change log

  1. Add format packages ConfigurationOptionLocator
  2. Generated html files for formats
  3. config.md to link all of the generated config html files.
  4. Change the class ConfigOptionsDocsCompletenessITCase to allow duplicated key ignore-parse-errors in both json and csv format.

Verifying this change

  1. Completeness is covered by ConfigOptionsDocsCompletenessITCase

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): (no)
  • The public API, i.e., is any changed class annotated with @Public(Evolving): (no)
  • The serializers: (no)
  • The runtime per-record code paths (performance sensitive): (no)
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: (no)
  • The S3 file system connector: (no)

Documentation

  • Does this pull request introduce a new feature? (no)
  • If yes, how is the feature documented? (docs)

HuangZhenQiu avatar Feb 05 '24 02:02 HuangZhenQiu

CI report:

  • 58f3d7b6073c5dd2c2a1deb8cde357d08abd3429 Azure: SUCCESS
Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build

flinkbot avatar Feb 05 '24 03:02 flinkbot

@leonardBang do you have time to help review this?

wuchong avatar Feb 26 '24 01:02 wuchong