zentol commented on a change in pull request #10982: [FLINK-15683][docs]
Restructure Configuration page
URL: https://github.com/apache/flink/pull/10982#discussion_r373779422
##########
File path:
flink-core/src/main/java/org/apache/flink/configuration/SecurityOptions.java
##########
@@ -33,34 +30,33 @@
/**
* The set of configuration options relating to security.
*/
-@PublicEvolving
-@ConfigGroups(groups = {
- @ConfigGroup(name = "Kerberos", keyPrefix = "security.kerberos"),
Review comment:
The core issue I have here is that we introduce an inconsistency in how
options are translated into include files, which make it impossible to
implement any safeguards to prevent dev errors. In my example above, the
generator won't complain about a new ssl option being added without a
common/expert annotation, because it will still be added to the file we
generate for each config class by default, and the generator assumes that all
include files are used in the documentation.
If on the other hand we would completely remove config groups, and the
default include file per config class, then we could mandate that every new
option must have a section annotation. This we could easily enforce.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
