Hi Alexander,

I haven't done a complete analysis yet. But through simple code search, roughly 
35 options would be added with this change. Also note that some old options 
defined in a ConfigConstant class won's be added here as flink-doc won't 
discover these constant-based options.

Best,
Zhanghao Chen
________________________________
From: Alexander Fedulov <alexander.fedu...@gmail.com>
Sent: Tuesday, October 31, 2023 18:12
To: d...@flink.apache.org <d...@flink.apache.org>
Cc: user@flink.apache.org <user@flink.apache.org>
Subject: Re: [DISCUSS][FLINK-33240] Document deprecated options as well

Hi Zhanghao,

Thanks for the proposition.
In general +1, this sounds like a good idea as long it is clear that the usage 
of these settings is discouraged.
Just one minor concern - the configuration page is already very long, do you 
have a rough estimate of how many more options would be added with this change?

Best,
Alexander Fedulov

On Mon, 30 Oct 2023 at 18:24, Matthias Pohl <matthias.p...@aiven.io.invalid> 
wrote:
Thanks for your proposal, Zhanghao Chen. I think it adds more transparency
to the configuration documentation.

+1 from my side on the proposal

On Wed, Oct 11, 2023 at 2:09 PM Zhanghao Chen 
<zhanghao.c...@outlook.com<mailto:zhanghao.c...@outlook.com>>
wrote:

> Hi Flink users and developers,
>
> Currently, Flink won't generate doc for the deprecated options. This might
> confuse users when upgrading from an older version of Flink: they have to
> either carefully read the release notes or check the source code for
> upgrade guidance on deprecated options.
>
> I propose to document deprecated options as well, with a "(deprecated)"
> tag placed at the beginning of the option description to highlight the
> deprecation status [1].
>
> Looking forward to your feedbacks on it.
>
> [1] https://issues.apache.org/jira/browse/FLINK-33240
>
> Best,
> Zhanghao Chen
>

Reply via email to