Hi Fluss community, I would like to discuss adopting auto-generated configuration documentation via the fluss-docgen module. Although this module exists, it has not yet been fully integrated.
PR #2474 [1] introduced fluss-docgen to generate configuration documentation from ConfigOptions.java. PR #2588 [2] extends this functionality by: - Grouping options using @Documentation.Section - Supporting @Documentation.OverrideDefault - Formatting Duration and MemorySize values - Replacing tables with grouped lists - Displaying deprecation notices - Replacing manual configuration tables with a generated MDX file PR #2588 has been open for several months and is currently blocked by two main issues: 1. Website CI: Since _partial_config.mdx is now git-ignored [3], the website build needs to run ./mvnw compile -pl fluss-docgen -am before npm run build. 2. ConfigOptions.java drift: The file has changed significantly since February, making rebases increasingly difficult. Proposal: I propose closing PR #2588 and opening a fresh PR against the latest main branch that includes: - The existing document generator improvements - Updated @Documentation.Section annotations - The required website CI changes - An updated configuration.md that imports the generated file I would appreciate your feedback on this approach, specifically regarding the CI changes. I am happy to prepare this for the 1.0 release. [1] https://github.com/apache/fluss/pull/2474 [2] https://github.com/apache/fluss/pull/2588 [3] https://github.com/apache/fluss/pull/3146 Best, Prajwal
