[FLINK-8475][config][docs] Integrate more ConfigOptions into documentation #5340
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
This PR significantly extends the integration of ConfigOptions into the configuration documentation. The only sections left to integrate are High-availability, ResourceManager and core options.
Each section was integrated in it's own commit that is essentially self-contained.
Most commits are straight-forward and revolve around setting up the description via
ConfigOption#withDescription
, generating the table and including it inconfig.md
.Some commits also include migration of existing
ConfigConstants
toConfigOptions
, but overall very few changes were made.This PR also includes a minor modification to the generated tables which renames the "Default Value" column to "Default" to save some space.
Verifying this change
The documentation changes can be verified by building the docs locally as described in in
flink/docs/README.md
.Does this pull request potentially affect one of the following parts:
@Public(Evolving)
: (yes)Documentation