Uploaded image for project: 'Flink'
  1. Flink
  2. FLINK-22471

Use formatted descriptions for connector options

    XMLWordPrintableJSON

Details

    Description

      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.

      Attachments

        Issue Links

          Activity

            People

              airblader Ingo Bürk
              airblader Ingo Bürk
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: