[
https://issues.apache.org/jira/browse/FLINK-8744?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16512255#comment-16512255
]
ASF GitHub Bot commented on FLINK-8744:
---------------------------------------
Github user StefanRRichter commented on the issue:
https://github.com/apache/flink/pull/5843
LGTM 👍
> Add annotations for documenting common/advanced options
> -------------------------------------------------------
>
> Key: FLINK-8744
> URL: https://issues.apache.org/jira/browse/FLINK-8744
> Project: Flink
> Issue Type: New Feature
> Components: Configuration, Documentation
> Reporter: Chesnay Schepler
> Assignee: Chesnay Schepler
> Priority: Trivial
> Fix For: 1.6.0
>
>
> The {{ConfigDocsGenerator}} only generates [the full configuration
> reference|https://ci.apache.org/projects/flink/flink-docs-master/ops/config.html#full-reference].
> The
> [common|https://ci.apache.org/projects/flink/flink-docs-master/ops/config.html#common-options]
> and
> [advanced|https://ci.apache.org/projects/flink/flink-docs-master/ops/config.html#advanced-options]
> sections are still manually defined in {{config.md}} and thus prone to being
> outdated / out-of-sync with the full reference.
> I propose adding {{@Common}}/{{@Advanced}} annotations based on which we
> could generate these sections as well.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
