Prajwal-banakar opened a new pull request, #2474:
URL: https://github.com/apache/fluss/pull/2474
<!--
*Thank you very much for contributing to Fluss - we are happy that you want
to help us improve Fluss. To help the community review your contribution in the
best possible way, please go through the checklist below, which will get the
contribution into a shape in which it can be best reviewed.*
## Contribution Checklist
- Make sure that the pull request corresponds to a [GitHub
issue](https://github.com/apache/fluss/issues). Exceptions are made for typos
in JavaDoc or documentation files, which need no issue.
- Name the pull request in the format "[component] Title of the pull
request", where *[component]* should be replaced by the name of the component
being changed. Typically, this corresponds to the component label assigned to
the issue (e.g., [kv], [log], [client], [flink]). Skip *[component]* if you are
unsure about which is the best component.
- Fill out the template below to describe the changes contributed by the
pull request. That will give reviewers the context they need to do the review.
- Make sure that the change passes the automated tests, i.e., `mvn clean
verify` passes.
- Each pull request should address only one issue, not mix up code from
multiple issues.
**(The sections below can be removed for hotfixes or typos)**
-->
### Purpose
<!-- Linking this pull request to the issue -->
Linked issue: close #469
<!-- What is the purpose of the change -->
The purpose of this change is to automate the generation of the
"Configuration Reference" documentation. Previously, this was a manual process
prone to "documentation drift." This new tool ensures the website is always
perfectly in sync with the ConfigOptions.java source file.
### Brief change log
<!-- Please describe the changes made in this pull request and explain how
they address the issue -->
New Module: Introduced fluss-docgen to house the documentation generation
logic (consistent with fluss-protogen).
Reflection Scanning: Implemented ConfigOptionsDocGenerator using Java
Reflection to scan for ConfigOption fields.
Categorization: Implemented grouping logic that categorizes configurations
by their key prefixes (e.g., Acl, Client, Server).
List-Based Display: Adopted a clean Markdown list format for better
readability and information density, as per the Restate documentation example.
Human-Readable Formatting: Integrated utilities to format Duration and
MemorySize default values into human-readable strings (e.g., 15 min, 64 mb).
Maven Lifecycle Integration: Bound the generator to the compile phase of the
fluss-docgen module to ensure docs are updated during the build process.
Idempotent Injection: The tool uses hidden markers (``) to safely inject
content into website/docs/configuration.md without duplicating or corrupting
existing content.
### Tests
<!-- List UT and IT cases to verify this change -->
Verification: Verified by deleting the configuration.md file and running a
full Maven reactor build; the file was successfully recreated with all
categorized options.
Idempotency: Verified that subsequent builds do not duplicate content.
Style: Passed spotless and checkstyle checks.
### API and Format
<!-- Does this change affect API or storage format -->
This change does not affect the public API or storage format of Fluss. It
only introduces a build-time utility module.
### Documentation
<!-- Does this change introduce a new feature -->
This PR introduces a new automated system for documentation. The generated
output is located at website/docs/configuration.md.
--
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]
