[
https://issues.apache.org/jira/browse/FLINK-33240?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17774021#comment-17774021
]
Zhanghao Chen commented on FLINK-33240:
---------------------------------------
[~mapohl] Exactly. I'm thinking of adding a "(deprecated)" tag at the beginning
of the option description. Also, we might better reach out to more devs and
users for more feedbacks on it. I'll be writing a discussion email. WDYT?
> Generate docs for deprecated options as well
> --------------------------------------------
>
> Key: FLINK-33240
> URL: https://issues.apache.org/jira/browse/FLINK-33240
> Project: Flink
> Issue Type: Improvement
> Components: Documentation
> Reporter: Zhanghao Chen
> Priority: Major
> Fix For: 1.19.0
>
>
> Currently, Flink will skip doc generation for deprecated options (See
> {{{}ConfigOptionsDocGenerator#{}}}{{{}shouldBeDocumented{}}}). As a result,
> the deprecated options can no longer be found in the new version of Flink
> document. This might confuse users upgrading from an older version of Flink
> and they have to either carefully read the release notes or check the source
> code for upgrading guidance on deprecated options. I suggest generating doc
> for deprecated options as well, and we should scan through the code to make
> sure that proper upgrading guidance is provided for the deprecated options.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
