peter-toth opened a new pull request, #658:
URL: https://github.com/apache/spark-kubernetes-operator/pull/658
### 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
--
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]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
