[GitHub] flink pull request #5468: [FLINK-8475][config][docs] Integrate Environment o...

[asfgit]

Github user asfgit closed the pull request at:

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


---

[GitHub] flink pull request #5468: [FLINK-8475][config][docs] Integrate Environment o...

[aljoscha]

Github user aljoscha commented on a diff in the pull request:

https://github.com/apache/flink/pull/5468#discussion_r167901255
  
--- Diff: docs/_includes/generated/environment_configuration.html ---
@@ -0,0 +1,41 @@
+
+
+
+Key
+Default
+Description
+
+
+
+
+env.java.opts
+(none)
+
--- End diff --

KK, go ahead, then. 👍 


---

[GitHub] flink pull request #5468: [FLINK-8475][config][docs] Integrate Environment o...

[zentol]

Github user zentol commented on a diff in the pull request:

https://github.com/apache/flink/pull/5468#discussion_r167833518
  
--- Diff: docs/_includes/generated/environment_configuration.html ---
@@ -0,0 +1,41 @@
+
+
+
+Key
+Default
+Description
+
+
+
+
+env.java.opts
+(none)
+
--- End diff --

There are plenty of missing descriptions, but I wanted to do that as a 
follow-up to get the basic setup in place first.


---

[GitHub] flink pull request #5468: [FLINK-8475][config][docs] Integrate Environment o...

[aljoscha]

Github user aljoscha commented on a diff in the pull request:

https://github.com/apache/flink/pull/5468#discussion_r167831861
  
--- Diff: docs/_includes/generated/environment_configuration.html ---
@@ -0,0 +1,41 @@
+
+
+
+Key
+Default
+Description
+
+
+
+
+env.java.opts
+(none)
+
--- End diff --

We could add a short descriptions about what these `opts` things actually 
do.


---

[GitHub] flink pull request #5468: [FLINK-8475][config][docs] Integrate Environment o...

[zentol]

GitHub user zentol opened a pull request:

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

[FLINK-8475][config][docs] Integrate Environment options

## What is the purpose of the change

This PR integrates the environment `ConfigOptions` into the configuration 
docs generator.

Note that the newly added config options are only evaluated in the shell 
scripts, which is rather unfortunate and may cause the docs to be outdated 
should we not find a way to guard this with tests.

## Brief change log

* Add missing descriptions to config options (derived from existing 
description/javadocs)
* integrate environment configuration table into `config.md`

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

$ git pull https://github.com/zentol/flink 8475_env

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

https://github.com/apache/flink/pull/5468.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 #5468


commit 0393908861b3d311fbf0761261260ebefffbd6eb
Author: zentol 
Date:   2018-01-30T13:45:10Z

[FLINK-8475][config][docs] Integrate Environment options




---