zentol commented on a change in pull request #10982: [FLINK-15683][docs]
Restructure Configuration page
URL: https://github.com/apache/flink/pull/10982#discussion_r373651280
##########
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:
> section option [are] simpler
This is debatable. The ConfigGroups were written on purpose the way they are
so that devs can add new options without having to worry or even know how the
docs are generated. You could just add a new kerberos option and it _would just
work_.
Meanwhile, if a dev now adds an option they have to decide whether the
option is common/expert, and if they forget to add any of the annotations are
at risk of the option not being documented at all.
----------------------------------------------------------------
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
