[jira] [Created] (FLINK-25777) Generate documentation for Table factories (formats and connectors)

["Francesco Guardiani (Jira)" <ji...@apache.org>]

Francesco Guardiani created FLINK-25777:
-------------------------------------------

             Summary: Generate documentation for Table factories (formats and connectors)
                 Key: FLINK-25777
                 URL: https://issues.apache.org/jira/browse/FLINK-25777
             Project: Flink
          Issue Type: Technical Debt
          Components: Connectors / Common, Documentation, Formats (JSON, Avro, Parquet, ORC, SequenceFile)
            Reporter: Francesco Guardiani


The goal of this issue is to generate automatically from code the documentation of configuration options for table connectors and formats.

This issue includes:

* Tweak {{ConfigOptionsDocGenerator}} to work with {{Factory#requiredOptions}}, {{Factory#requiredOptions}} and newly introduced {{DynamicTableFactory#forwardOptions}} and {{FormatFactory#forwardOptions}}. Also see this https://github.com/apache/flink/pull/18290 as reference. From these methods we should extract if an option is required or not, and if it's forwardable or not.
* Decide whether the generator output should be, and how to link/include it in the connector/format docs pages.
* Enable the code generator in CI.
* Regenerate all the existing docs.



--
This message was sent by Atlassian Jira
(v8.20.1#820001)