Prajwal-banakar opened a new pull request, #2588:
URL: https://github.com/apache/fluss/pull/2588
<!--
*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 #2586
<!-- What is the purpose of the change -->
The purpose of this change is to enhance the ConfigOptionsDocGenerator to
produce cleaner, more professional MDX documentation. It fixes several
formatting artifacts in the auto-generated configuration files, such as Table
to list, incorrect type rendering and unformatted description placeholders, and
improves the overall code quality of the generator itself.
### Brief change log
<!-- Please describe the changes made in this pull request and explain how
they address the issue -->
Changed table to list format for better readability
Enhanced Type Formatting: Refined the getType() logic to strip trailing
generic brackets (e.g., converting String> to String) and normalized common
Java types for documentation.
Improved Descriptions: Updated cleanDescription() to replace %s placeholders
with true to ensure generated sentences are grammatically complete and readable.
Refined Scoping: Improved the logic for the "Scope" field to correctly
categorize configurations as Client, Table, or Server based on their key
prefixes.
Code Quality & Checkstyle: * Fixed "ignored return value" warnings for
File.mkdirs().
Optimized imports and resolved reflective access warnings for the Internal
annotation.
Decoupled the generator from ConfigDocUtils to ensure it can run as a
standalone utility without classpath resolution issues.
### Tests
<!-- List UT and IT cases to verify this change -->
Manually verified by running the ConfigOptionsDocGenerator main method and
inspecting the resulting _partial_config.mdx file.
Verified that the generated MDX renders correctly in a Markdown previewer
with working anchors and valid formatting.
Ran ./mvnw compile -pl fluss-docgen -am it passed perfectly
<img width="1920" height="1080" alt="Screenshot 2026-02-06 142046"
src="https://github.com/user-attachments/assets/e80054a1-f99e-41b8-942a-0aa927308d22";
/>
### API and Format
<!-- Does this change affect API or storage format -->
This change does not affect the Fluss runtime API or storage format. It only
affects the internal documentation generation tool and the resulting .mdx files.
### Documentation
<!-- Does this change introduce a new feature -->
This PR improves the quality of the existing configuration documentation. No
new user-facing features were added.
--
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]
