[hotfix][docs] Document config options missing from the configuration reference - #28895
Open
spuru9 wants to merge 1 commit into
Open
[hotfix][docs] Document config options missing from the configuration reference#28895spuru9 wants to merge 1 commit into
spuru9 wants to merge 1 commit into
Conversation
… reference rest.url-prefix and shuffle-service-factory.class lacked @Documentation.Section, so they were emitted only into per-class generated tables that no documentation page includes. Annotate both and regenerate. Also add python.logging.default.level and python.logging.level.overrides to the PyFlink configuration page, and regenerate the Chinese message catalog. Generated-by: Claude Code (claude-opus-5)
Collaborator
Contributor
Author
|
@dianfu @davidradl Can you take a look |
spuru9
commented
Aug 3, 2026
| /** | ||
| * The full class name of the shuffle service factory implementation to be used by the cluster. | ||
| */ | ||
| @Documentation.Section(Documentation.Sections.EXPERT_CLUSTER) |
Contributor
Author
There was a problem hiding this comment.
Need some feeback on this.
github-actions
Bot
added
the
community-reviewed
1 task
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What is the purpose of the change
Four config options never appeared in the documentation.
rest.url-prefixandshuffle-service-factory.classcarry no@Documentation.Section, so the generator emits them only into per-class tables that no page includes. Two PyFlink logging options were missing from the PyFlink configuration page.Brief change log
rest.url-prefixwithCOMMON_HOST_PORT(matching its siblingrest.path) andshuffle-service-factory.classwithEXPERT_CLUSTER; regenerate the two affected section tables.python.logging.default.levelandpython.logging.level.overrides(added in FLINK-38690) toflink-python/docs/user_guide/configuration.rst.make gettext+sphinx-intl update. New entries are intentionally left untranslated.Verifying this change
This change is already covered by existing tests:
ConfigOptionsDocsCompletenessITCase, run withmvn package -pl flink-docs -am. Re-running the generator afterwards produces no further diff, and all four options now render on the configuration reference or the PyFlink configuration page.Does this pull request potentially affect one of the following parts:
@Public(Evolving): yes —RestOptionsandShuffleServiceOptionsare@PublicEvolving, but only a documentation annotation was added; no API changeDocumentation
Was generative AI tooling used to co-author this PR?
Generated-by: Claude Code (claude-opus-5)