[jira] [Commented] (FLINK-30862) Config doc generation should keep @deprecated ConfigOption

["Chesnay Schepler (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/FLINK-30862?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17682972#comment-17682972 ] 

Chesnay Schepler commented on FLINK-30862:
------------------------------------------

I disagree.

There are 2 possible scenarios:
a) an option is deprecated because the related features was removed, and is only kept for source compatibility. There's no point to document this option.
b) an option _key_ is deprecated, being subsumed by a new key. There are certain option keys that go back half a decade;the config page is overloaded as-is, so adding more just makes things even worse

I will say that there should be better documentation for _migrating_ from deprecated options, but this to me is quite different than unilaterally showing all deprecated options in the docs.

> Config doc generation should keep @deprecated ConfigOption
> ----------------------------------------------------------
>
>                 Key: FLINK-30862
>                 URL: https://issues.apache.org/jira/browse/FLINK-30862
>             Project: Flink
>          Issue Type: Improvement
>            Reporter: Jing Ge
>            Assignee: Jing Ge
>            Priority: Major
>
> Currently the content will be removed once the ConfigOption is marked as @deprecated. It should be kept, since the ConfigOption is only deprecated and still be used. The content should be only removed when the ConfigOption has been removed.
>  



--
This message was sent by Atlassian Jira
(v8.20.10#820010)