[
https://issues.apache.org/jira/browse/FLINK-5781?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16002599#comment-16002599
]
ASF GitHub Bot commented on FLINK-5781:
---------------------------------------
Github user zentol commented on the issue:
https://github.com/apache/flink/pull/3495
2 more issues popped up:
A large number of configuration parameters have not been ported yet (see
[FLINK-4765](https://issues.apache.org/jira/browse/FLINK-4765) which means that
we cannot use this for all options right away.
More importantly, our organization of ConfigOptions isn't coherent with the
existing organization in the docs. For example, all JobManager and WebFrontend
options life in `JobManagerOptions`, but in the docs they are 2 different
tables. The same issue applies to the Security Options, with SSl, Kerberos and
Zookeper sharing the same file.
Creating the tables based on the ConfigOption classes does not appear to be
granular enough to provide a good documentation.
I'm currently leaning towards adding annotations that group the contained
config options based on a key prefix. Here's an example how it could look like
for the `SecurityOptions`:
```
@ConfigGroups(
@ConfigGroup("Kerberos", "security.kerberos"),
@ConfigGroup("SSL, "security.ssl"),
@ConfigGroup("Zookeeper", "zookeeper"))
public class SecurityOptions {
}
```
In this example we would use this annotation to generate 3 different
tables, with proper names.
> Generation HTML from ConfigOption
> ---------------------------------
>
> Key: FLINK-5781
> URL: https://issues.apache.org/jira/browse/FLINK-5781
> Project: Flink
> Issue Type: Sub-task
> Components: Documentation
> Reporter: Ufuk Celebi
> Assignee: Dawid Wysakowicz
>
> Use the ConfigOption instances to generate a HTML page that we can use to
> include in the docs configuration page.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
