[SPARK-49527] Add ConfOptionDocGenerator to generate Spark Operator Config Property Doc
#118
Conversation
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
Contributor
Author
|
also cc @viirya |
| */ | ||
|
|
||
| ext { | ||
| javaMainClass = "org.apache.spark.k8s.operator.utils.ConfOptionDocGenerator" |
Member
There was a problem hiding this comment.
2-space indentation please.
Member
dongjoon-hyun
left a comment
dongjoon-hyun
left a comment
There was a problem hiding this comment.
Was it technically impossible to put under build-tools as I suggested?
settings.gradle
Outdated
| include 'spark-submission-worker' | ||
| include 'spark-operator' | ||
| include 'docs-utils' | ||
|
|
dongjoon-hyun
changed the title
ConfOptionDocGenerator to generate Spark Operator Config Property Doc
Member
dongjoon-hyun
left a comment
dongjoon-hyun
left a comment
There was a problem hiding this comment.
Could you make CIs happy?
Let's not add docs in this PR.
dongjoon-hyun
approved these changes
Sep 11, 2024
Member
Member
|
Let me re-trigger it. |
Member
|
Merged to main. |
jiangzho
pushed a commit
to jiangzho/spark-kubernetes-operator
that referenced
this pull request
Jul 17, 2025
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 changes were proposed in this pull request?
This PR adds a module
docs-utilsto automatically generate config properties doc page from source.Why are the changes needed?
This helps to keep config property docs up-to-date for properties by adding it as a gradle task.
Does this PR introduce any user-facing change?
No (doc only, not released)
How was this patch tested?
Pass the CIs
Was this patch authored or co-authored using generative AI tooling?
No