[GitHub] flink pull request #5119: [FLINK-6590] Integrate automatic docs generation

Mon, 04 Dec 2017 06:50:20 -0800 

GitHub user zentol opened a pull request:

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

    [FLINK-6590] Integrate automatic docs generation

    Rebased version of #3916; builds on #5052.
    
    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
    
    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

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

    https://github.com/apache/flink/pull/5119.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 #5119
    
----
commit 1d99d366bbcb1c8eb9d2fdd8e303838339da9dd2
Author: zentol <[email protected]>
Date:   2017-11-20T16:28:24Z

    [FLINK-8133][REST][docs] Generate REST API documentation

commit 525d25b56fc026ec65a3fb5b238078b8d19ff9c8
Author: zentol <[email protected]>
Date:   2017-11-29T15:07:12Z

    add README.md

commit daf05fa4e99281cda8ae4b0536c5985b09d43d42
Author: zentol <[email protected]>
Date:   2017-12-04T13:38:39Z

    fix checkstyle

commit fd703ce0e31b7a6b49278c92819f519f91396f4f
Author: zentol <[email protected]>
Date:   2017-05-15T19:06:38Z

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

commit 6a57b37b48f006f5775e09b08d3891d09b58ea04
Author: zentol <[email protected]>
Date:   2017-12-04T14:07:56Z

    [FLINK-6590][docs] Move config docs generator to flink-docs

commit c0adff1ab4ec92b733749611b96ff546907531d4
Author: zentol <[email protected]>
Date:   2017-12-04T14:31:21Z

    [FLINK-6590][docs] Human-readable html table

commit 16818ff1f888939899a95834fe7a35577f5ed1f2
Author: zentol <[email protected]>
Date:   2017-12-04T14:32:21Z

    integrate web configuration

commit 5772dca0a9e96f4fc01cd93268b123a8bc18f5ab
Author: zentol <[email protected]>
Date:   2017-12-04T14:36:03Z

    integrate kerberos/ZK security configuration

commit 854f6eb2e32d5b64ba95eca7dc30938fa20c0164
Author: zentol <[email protected]>
Date:   2017-12-04T14:36:39Z

    integrate QS configuration

commit 8dea63069517371b1758769a468a7f25abafe301
Author: zentol <[email protected]>
Date:   2017-12-04T14:36:57Z

    integrate metrics configuration

commit d42c55a49510a70bc3c57fff9a75015c6f4e1b60
Author: zentol <[email protected]>
Date:   2017-12-04T14:37:22Z

    integrate history server configuration

commit 9b5012db2f827726015aaecff66b09f6112d287f
Author: zentol <[email protected]>
Date:   2017-12-04T14:45:14Z

    extend README.md

----


---

Reply via email to