[SPARK-56747] Fix typos and stale examples in documentation#658
Closed
peter-toth wants to merge 1 commit intoapache:mainfrom
Closed
[SPARK-56747] Fix typos and stale examples in documentation#658peter-toth wants to merge 1 commit intoapache:mainfrom
peter-toth wants to merge 1 commit intoapache:mainfrom
Conversation
### What changes were proposed in this pull request? This PR fixes typos, a broken markdown link, a structurally broken YAML example, and stale content in the documentation under `docs/`. - `docs/spark_custom_resources.md`: - Re-indent `maxRestartAttempts` inside `restartConfig` in the resource-retain example (previously misplaced at `applicationTolerations` level). - Refresh the Spark Pi example to match `examples/pi.yaml`: bump to Spark 4.1.1, drop the obsolete `scalaVersion` field, and add `ttlAfterStopMillis`. - Fix the dangling sentence in the "Understanding Failure Types" section so the `DriverStartTimedOut` / `ExecutorsStartTimedOut` / `SchedulingFailure` enumeration flows into the infrastructure-failure explanation. - Clarify the `maxRestartOnFailure=2` arithmetic example: the app tolerates 2 consecutive failures and stops on the 3rd. - `docs/configuration.md`: - Fix the broken markdown link to `spark-operator.properties` that was split mid-path across two lines. - `docs/operations.md`: - "config mapas" -> "config map as" in the Helm values table. - "Java 21, 25 and 26" -> "Java 21 or newer", aligning with the README badge and the Java-21 compatibility check in `build.gradle`. - "API compatible as possible" -> "as API compatible as possible". - Refresh the `helm list -A` example output to match the current `Chart.yaml` (chart `1.7.0-dev`, appVersion `0.9.0-SNAPSHOT`). ### Why are the changes needed? These are documentation-only corrections. Some were factual errors (misindented YAML example, broken markdown link, dangling sentence that leaves the reader without the intended conclusion), others were stale content that no longer matched the code or chart state, and the rest were minor typos and grammar fixes. ### Does this PR introduce _any_ user-facing change? Yes, documentation-only user-facing changes. ### How was this patch tested? Manual review of the rendered markdown and cross-checked against `examples/pi.yaml`, `build.gradle`, `build-tools/helm/spark-kubernetes-operator/Chart.yaml`, and `build-tools/helm/spark-kubernetes-operator/values.yaml`. ### Was this patch authored or co-authored using generative AI tooling? Generated-by: Claude Opus 4.7
Contributor
Author
dongjoon-hyun
approved these changes
May 6, 2026
Member
dongjoon-hyun
left a comment
dongjoon-hyun
left a comment
There was a problem hiding this comment.
+1, LGTM. Thank you, @peter-toth .
Member
|
Feel free to merge, @peter-toth . |
Contributor
Author
|
Thank you @dongjoon-hyun. Merged to |
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 changes were proposed in this pull request?
This PR fixes typos, a broken markdown link, a structurally broken YAML example, and stale content in the documentation under
docs/.docs/spark_custom_resources.md:maxRestartAttemptsinsiderestartConfigin the resource-retain example (previously misplaced atapplicationTolerationslevel).examples/pi.yaml: bump to Spark 4.1.1, drop the obsoletescalaVersionfield, and addttlAfterStopMillis.DriverStartTimedOut/ExecutorsStartTimedOut/SchedulingFailureenumeration flows into the infrastructure-failure explanation.maxRestartOnFailure=2arithmetic example: the app tolerates 2 consecutive failures and stops on the 3rd.docs/configuration.md:spark-operator.propertiesthat was split mid-path across two lines.docs/operations.md:build.gradle.helm list -Aexample output to match the currentChart.yaml(chart1.7.0-dev, appVersion0.9.0-SNAPSHOT).Why are the changes needed?
These are documentation-only corrections. Some were factual errors (misindented YAML example, broken markdown link, dangling sentence that leaves the reader without the intended conclusion), others were stale content that no longer matched the code or chart state, and the rest were minor typos and grammar fixes.
Does this PR introduce any user-facing change?
Yes, documentation-only user-facing changes.
How was this patch tested?
Manual review of the rendered markdown and cross-checked against
examples/pi.yaml,build.gradle,build-tools/helm/spark-kubernetes-operator/Chart.yaml, andbuild-tools/helm/spark-kubernetes-operator/values.yaml.Was this patch authored or co-authored using generative AI tooling?
Generated-by: Claude Opus 4.7