Zhanghao Chen created FLINK-33240:
-------------------------------------
Summary: 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
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)
