[
https://issues.apache.org/jira/browse/FLINK-8744?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16489516#comment-16489516
]
ASF GitHub Bot commented on FLINK-8744:
---------------------------------------
Github user StephanEwen commented on the issue:
https://github.com/apache/flink/pull/5843
One could add an int to the annotation, as "priority / position" and sort
by that.
Not sure nice, but could be okay.
I think it was nice for users that the most common options (the ones you
need first) were at the top of the list.
Out of curiosity, what happens to options like `env.java.opts` which are
shell script only options, but very common?
> Add annotations for documentation 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.5.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)
