adutra opened a new pull request, #3838: URL: https://github.com/apache/polaris/pull/3838
This PR leverages the existing docs generator tool to expose a comprehensive configuration reference documentation for the Polaris site **including feature flags**. This extends the existing `config-docs` generator to support two types of configuration sources: 1. SmallRye Config properties (from `@ConfigMapping` annotated interfaces) 2. `PolarisConfiguration` static fields (both `FeatureConfiguration` and `BehaviorChangeConfiguration`) Key changes: - Modified `DocGenDoclet` to extract configuration metadata from `FeatureConfiguration` and `BehaviorChangeConfiguration` static fields using reflection and javadoc processing. - Add new Gradle task to copy generated docs to the site content directory with proper Hugo front matter - Reorganize site configuration documentation into a dedicated section with separate pages for configuration overview and reference - Add CI workflow step to verify generated configuration docs are up-to-date The generated documentation includes property names, descriptions, default values, types, and catalog config mappings where applicable. <!-- ๐ Describe what changes you're proposing, especially breaking or user-facing changes. ๐ See https://github.com/apache/polaris/blob/main/CONTRIBUTING.md for more. --> ## Checklist - [ ] ๐ก๏ธ Don't disclose security issues! (contact [email protected]) - [ ] ๐ Clearly explained why the changes are needed, or linked related issues: Fixes # - [ ] ๐งช Added/updated tests with good coverage, or manually tested (and explained how) - [ ] ๐ก Added comments for complex logic - [ ] ๐งพ Updated `CHANGELOG.md` (if needed) - [ ] ๐ Updated documentation in `site/content/in-dev/unreleased` (if needed) -- 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]
