You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2018/01/23 14:28:00 UTC
[jira] [Commented] (FLINK-8475) Move remaining sections to
generated tables
[ https://issues.apache.org/jira/browse/FLINK-8475?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16335830#comment-16335830 ]
ASF GitHub Bot commented on FLINK-8475:
---------------------------------------
GitHub user zentol opened a pull request:
https://github.com/apache/flink/pull/5340
[FLINK-8475][config][docs] Integrate more ConfigOptions into documentation
## What is the purpose of the change
This PR significantly extends the integration of ConfigOptions into the configuration documentation. The only sections left to integrate are High-availability, ResourceManager and core options.
Each section was integrated in it's own commit that is essentially self-contained.
Most commits are straight-forward and revolve around setting up the description via `ConfigOption#withDescription`, generating the table and including it in `config.md`.
Some commits also include migration of existing `ConfigConstants` to `ConfigOptions`, but overall very few changes were made.
This PR also includes a minor modification to the generated tables which renames the "Default Value" column to "Default" to save some space.
## Verifying this change
The documentation changes can be verified by building the docs locally as described in in `flink/docs/README.md`.
## Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): (no)
- The public API, i.e., is any changed class annotated with `@Public(Evolving)`: (yes)
- The serializers: (no)
- The runtime per-record code paths (performance sensitive): (no)
- Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Yarn/Mesos, ZooKeeper: (no)
- The S3 file system connector: (no)
## Documentation
- Does this pull request introduce a new feature? (no)
- If yes, how is the feature documented? (not applicable)
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/zentol/flink 8475
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/5340.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 #5340
----
commit bfd0f7b345beba096c253ec8e958810a58039f96
Author: zentol <ch...@...>
Date: 2018-01-23T12:07:56Z
[hotfix][config][docs] Rename "Default Value" column to "Default"
commit b2fec9011900004f9d43819ba5f1dc617e8461a5
Author: zentol <ch...@...>
Date: 2018-01-22T15:16:02Z
[FLINK-8475][config][docs] Integrate FS options
commit fc45fbc4ba5608b8c6241dc6b63ecb20f56dc33f
Author: zentol <ch...@...>
Date: 2018-01-22T15:29:55Z
[FLINK-8475][config][docs] Integrate akka options
commit 8c02b4327f6b6bcb56a40597037ab2409b4bc3d6
Author: zentol <ch...@...>
Date: 2018-01-22T15:35:19Z
[FLINK-8475][config][docs] Integrate SSL options
commit 5cc2d5a4ade5f531ab80695dd84fe7a1f48442b4
Author: zentol <ch...@...>
Date: 2018-01-22T15:40:20Z
[FLINK-8475][config][docs] Integrate SlotManager options
commit 1b14be8df4f074be2c2a00f351ed60e7d71fa7ee
Author: zentol <ch...@...>
Date: 2018-01-22T16:02:12Z
[FLINK-8475][config][docs] Integrate netty options
commit a5a640df58056f4032f63857186463afc6adf3b6
Author: zentol <ch...@...>
Date: 2018-01-22T16:32:38Z
[FLINK-8475][config][docs] Integrate JM options
commit fceb0846b60ae4eb2fd509f9fcf2182b99ff8687
Author: zentol <ch...@...>
Date: 2018-01-22T17:15:34Z
[FLINK-8475][config][docs] Integrate TM options
commit d6be498f905f32be9fe3c1cfa57d30cd8c2ab17f
Author: zentol <ch...@...>
Date: 2018-01-23T12:20:08Z
[FLINK-8475][config][docs] Integrate optimizer options
commit b97aec3a8d359b602b276c2f5540a56239e898c7
Author: zentol <ch...@...>
Date: 2018-01-23T12:50:32Z
[FLINK-8475][config][docs] Integrate HA-ZK options
commit a05e5fc9c1ab1bf18d013873839e661b402cf8be
Author: zentol <ch...@...>
Date: 2018-01-23T13:04:36Z
[FLINK-8475][config][docs] Integrate YARN options
commit 334cc320c1acf2b06b47128feafa96354055299e
Author: zentol <ch...@...>
Date: 2018-01-23T13:20:12Z
[FLINK-8475][config][docs] Integrate Mesos options
commit b461822d88499b819bf36c8b46d2dc1e4d2ee65f
Author: zentol <ch...@...>
Date: 2018-01-23T13:44:00Z
[FLINK-8475][config][docs] Integrate BlobServer options
commit 79bd1e23b401ac107bcd1796f090a485a38b9e98
Author: zentol <ch...@...>
Date: 2018-01-23T13:48:24Z
[FLINK-8475][config][docs] Integrate HeartbeatManager options
commit f2fdad0596ec874297dcc3c09d25204b174a9b13
Author: zentol <ch...@...>
Date: 2018-01-23T13:52:22Z
[FLINK-8475][config][docs] Integrate REST options
commit 29960aaa12ad0f624a7e992e31b603ab0b2c8e76
Author: zentol <ch...@...>
Date: 2018-01-23T13:57:20Z
[FLINK-8475][config][docs] Integrate Checkpointing options
----
> Move remaining sections to generated tables
> -------------------------------------------
>
> Key: FLINK-8475
> URL: https://issues.apache.org/jira/browse/FLINK-8475
> Project: Flink
> Issue Type: Sub-task
> Components: Configuration
> Reporter: Chesnay Schepler
> Assignee: Chesnay Schepler
> Priority: Major
> Fix For: 1.5.0
>
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)