flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (FLINK-8744) Add annotations for documenting common/advanced options
Date Thu, 14 Jun 2018 23:52:00 GMT

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

ASF GitHub Bot commented on FLINK-8744:
---------------------------------------

Github user asfgit closed the pull request at:

    https://github.com/apache/flink/pull/5843


> 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)

Mime
View raw message