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 documentation common/advanced options
Date Thu, 12 Apr 2018 17:49:00 GMT

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

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

GitHub user zentol opened a pull request:

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

    [FLINK-8744][docs] Generate "Common Option" section

    Base on #5822.
    
    ## What is the purpose of the change
    
    With this PR the "Common Options" section is now generated by the `ConfigOptionDocsGenerator`.
    
    ## Brief change log
    
    * add ┬┤CommonOption` annotation
    * annotate a few options with added annotation
      * I was very conservative as i do **not** want to discuss in this PR which options should
be regarded as common
    * extend the generator to gather all annotated options and generated a HTML table
    * replace common section with generated file
    * remove advanced section, as subsumed by full reference
    
    ## Verifying this change
    
    * run `ConfigOptionsDocGeneratorTest#testCommonOptions`


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/zentol/flink 8744

Alternatively you can review and apply these changes as the patch at:

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

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #5843
    
----
commit ee191707fc9ed538afc44818289454eba66e977b
Author: zentol <chesnay@...>
Date:   2018-04-05T10:42:42Z

    [FLINK-8743][docs] Allow overriding documented default

commit 5e1f8a63dc985ac7b5021c85ee77d8e04b58ba74
Author: zentol <chesnay@...>
Date:   2018-04-12T11:27:09Z

    [FLINK-8744][docs] Add CommonOption annotation

commit 036de7d73148f6d824d6aa4cb8fd3e463962bd9c
Author: zentol <chesnay@...>
Date:   2018-04-12T11:38:12Z

    [FLINK-8744][docs] Integrate CommonOption annotation

----


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

Mime
View raw message