[jira] [Created] (FLINK-22471) Use formatted descriptions for connector options

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[jira] [Created] (FLINK-22471) Use formatted descriptions for connector options

Shang Yuanchun (Jira)
Ingo Bürk created FLINK-22471:
---------------------------------

             Summary: Use formatted descriptions for connector options
                 Key: FLINK-22471
                 URL: https://issues.apache.org/jira/browse/FLINK-22471
             Project: Flink
          Issue Type: Improvement
          Components: Connectors / ElasticSearch, Connectors / JDBC, Connectors / Kafka, Connectors / Kinesis
    Affects Versions: 1.12.2, 1.13.0
            Reporter: Ingo Bürk


The documentation for connector options is currently not yet generated. This leads to a duplication, and in general there are deviations between the documentation and the description of the <ConfigOption>s.

Importantly, these descriptions are in many places not suitable for the automatic generation due to hard-coded linebreaks, and in general not making use of the Description/Formatter infrastructure yet.

A lot of them also duplicate things like "required" or default values in the description.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)