[jira] [Commented] (FLINK-6590) Integrate generated tables into documentation

Tue, 16 May 2017 00:59:43 -0700 

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

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

GitHub user zentol opened a pull request:

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

    [FLINK-6590] Integrate automatic docs generation

    This PR partially integrates the docs generation introduced in 
FLINK-5781/#3495  into the actual documentation.
    
    The following sections now use the generated tables:
    * WebFrontend
    * Metrics
    * Kerberos
    * Zookeper (security)
    * Queryable state
    * HistoryServer
    * Environment options (`java.opts. ...`)
    
    Of course, some pictures:
    
    
![web](https://cloud.githubusercontent.com/assets/5725237/26095424/d4bec9bc-3a1d-11e7-828f-b7f1d65c959d.png)
    
![metrics](https://cloud.githubusercontent.com/assets/5725237/26095426/d7c83850-3a1d-11e7-892a-0c2c74926ab4.png)
    
![kerberos](https://cloud.githubusercontent.com/assets/5725237/26095428/d9e31f38-3a1d-11e7-8dfe-2e4c885349e6.png)
    
![zookeeper](https://cloud.githubusercontent.com/assets/5725237/26095430/ddccaa74-3a1d-11e7-9ca4-e9cfaf927d57.png)
    
![qs](https://cloud.githubusercontent.com/assets/5725237/26095434/e005d23e-3a1d-11e7-8cb6-705af8b4af31.png)
    
![hs](https://cloud.githubusercontent.com/assets/5725237/26095435/e273d426-3a1d-11e7-907d-d4a1ed4aa225.png)
    
    For the parameters listed under `Common Options` i propose simply linking 
to the corresponding table as shown here:
    
![env1](https://cloud.githubusercontent.com/assets/5725237/26095446/f27ec68c-3a1d-11e7-9aad-9df6c014e5a1.png)
    
![env2](https://cloud.githubusercontent.com/assets/5725237/26095449/f4200500-3a1d-11e7-96e8-1422172be1fd.png)
    


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

    $ git pull https://github.com/zentol/flink 6590_docs_integration

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

    https://github.com/apache/flink/pull/3916.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 #3916
    
----
commit c34da6740e5dc47c21be331650b1bd98c6957649
Author: zentol <[email protected]>
Date:   2017-05-15T19:06:38Z

    [FLINK-6590][docs] Disable empty line before h5-h7 in css

commit 0cfed1b41f66bd8aa5fbc6ee275e68140d33225b
Author: zentol <[email protected]>
Date:   2017-05-15T14:35:36Z

    [FLINK-6590][docs] Auto-generate WebFrontend documentation

commit 028eea0feb8d331ae0ea5ebd0a25c03322e116e1
Author: zentol <[email protected]>
Date:   2017-05-15T14:38:37Z

    [FLINK-6590][docs] Auto-generate Metrics documentation

commit 4125a392bca0e94f668cfaec34c7e35b7b740508
Author: zentol <[email protected]>
Date:   2017-05-15T14:44:37Z

    [FLINK-6590][docs] Auto-generate Kerberos/Zookeeper documentation

commit fa18aa383f8e5d8b4af793a53a52af93d2adba82
Author: zentol <[email protected]>
Date:   2017-05-15T14:46:51Z

    [FLINK-6590][docs] Auto-generate Queryable State documentation

commit 28f517adebf0158a39218feb8b89bd0e74cdd827
Author: zentol <[email protected]>
Date:   2017-05-15T14:57:44Z

    [FLINK-6590][docs] Auto-generate HistoryServer documentation

commit 47fc5c00a30dc630696efd85b0b7cf5de2169072
Author: zentol <[email protected]>
Date:   2017-05-15T14:58:08Z

    [FLINK-6590][docs] Auto-generate Environment Options documentation

----


> Integrate generated tables into documentation
> ---------------------------------------------
>
>                 Key: FLINK-6590
>                 URL: https://issues.apache.org/jira/browse/FLINK-6590
>             Project: Flink
>          Issue Type: Sub-task
>          Components: Documentation
>            Reporter: Chesnay Schepler
>            Assignee: Chesnay Schepler
>




--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

Reply via email to