wuchong commented on issue #469: URL: https://github.com/apache/fluss/issues/469#issuecomment-3765470633
Hi @Prajwal-banakar , thanks for taking this issue. This would be a huge contribution to the community. Quick answers: - Module: I suggest `fluss-docgen` (as we already have `fluss-protogen` and will introduce `fluss-codegen` soon). The `fluss-docs` sounds like it places doc markdown files in it, but not. - Approach: The annotation is used to identify the category/section the config belongs to. So I think we may need annotations or adding variables to the `ConfigOption` class. - Execution: +1 for maven plugin. - Display: I think table format is hard to display more content, and not compact. I suggest to use list format with default values and types are labeled after the config key. A good example: https://docs.restate.dev/references/server-config#param-log-filter Besides, Kafka also has config doc generation framework: - https://github.com/apache/kafka/blob/trunk/clients/src/main/java/org/apache/kafka/common/config/ConfigDef.java - https://kafka.apache.org/41/configuration/broker-configs/#updating-ssl-keystore-of-an-existing-listener -- 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. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
