You are viewing a plain text version of this content. The canonical link for it is here.

Posted to issues@flink.apache.org by "Chesnay Schepler (JIRA)" <ji...@apache.org> on 2018/02/22 08:58:03 UTC

[jira] [Created] (FLINK-8744) Add annotations for documentation common/advanced options

Chesnay Schepler created FLINK-8744:
---------------------------------------

             Summary: 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


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)