Hi Zhanghao,

Thank you for the proposal.

+1 from my side. It would be more user-friendly to have the deprecated
options in the same section as the non-deprecated ones. Therefore, adding
them in the same section sounds good to me.

Best regards,
Junrui

Zhanghao Chen <zhanghao.c...@outlook.com> 于2023年11月1日周三 21:10写道:

> Hi Samrat and Ruan,
>
> Thanks for the suggestion. I'm actually in favor of adding the deprecated
> options in the same section as the non-deprecated ones. This would make
> user search for descriptions of the replacement options more easily. It
> would be a different story for options deprecated because the related
> API/module is entirely deprecated, e.g. DataSet API. In that case, users
> would not search for replacement on an individual option but rather need to
> migrate to a new API, and it would be better to move these options to a
> separate section. WDYT?
>
> Best,
> Zhanghao Chen
> ________________________________
> From: Samrat Deb <decordea...@gmail.com>
> Sent: Wednesday, November 1, 2023 15:31
> To: dev@flink.apache.org <dev@flink.apache.org>
> Cc: u...@flink.apache.org <u...@flink.apache.org>
> Subject: Re: [DISCUSS][FLINK-33240] Document deprecated options as well
>
> Thanks for the proposal ,
> +1 for adding deprecated identifier
>
> [Thought] Can we have seperate section / page for deprecated configs ? Wdut
> ?
>
>
> Bests,
> Samrat
>
>
> On Tue, 31 Oct 2023 at 3:44 PM, Alexander Fedulov <
> alexander.fedu...@gmail.com> wrote:
>
> > 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
> > >
> > > 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