flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Stephan Ewen (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (FLINK-8744) Add annotations for documentation common/advanced options
Date Thu, 22 Feb 2018 09:39:06 GMT

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

Stephan Ewen commented on FLINK-8744:

IIRC, we initially had only "common" and "advanced" was the full reference.

Do you think we need "advanced" or we will get away with only "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
> 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

View raw message