NoahKusaba opened a new pull request, #2480: URL: https://github.com/apache/datafusion-ballista/pull/2480
# Rationale for this change The docs pasted Rust examples and config tables by hand, and every copy had drifted. The three copies of the remote examples disagreed with each other. The `extending-components` S3 snippets built a runtime with `RuntimeConfig`, which was removed in DataFusion 55, while the prose claimed they *were* the shipped implementations. # What changes are included in this PR? - `rust.md`, `quick-start.md` and `examples/README.md` include the examples from `examples/examples/` with `literalinclude` instead of pasting them. `examples/README.md` now links to each example instead of repeating it. - The three S3 helpers in `extending-components.md` are included from `ballista/core/src/object_store.rs`, anchored on doc comments rather than line numbers. The scheduler and executor snippets are rewritten to match `custom-scheduler.rs` and `custom-executor.rs`. - The hand-maintained config tables in the tuning guide become generated regions, so the existing config-docs CI check keeps them in sync. - `docs.yaml` now rebuilds the site when `examples/examples/**` or `object_store.rs` changes, since the docs now embed them. - Remove the duplicate `SET s3.allow_http = true` from `custom-client.rs` and the three S3 integration tests. It is dead: `allow_http` is read only in `s3_object_store_builder`, from a fresh config read. # Are there any user-facing changes? Documentation, plus one line dropped from an example and three from tests. Verified: `sphinx-build -W` is clean when combined with #2476, `./dev/update_config_docs.sh --check` passes, and `cargo check -p ballista-examples --all-targets --all-features` passes. When this lived in #2438, the S3 integration tests passed with `--features testcontainers`, and the rendered snippets were byte-identical to the source slices. Split out of #2438 to make it easier to review. 🤖 Generated with [Claude Code](https://claude.com/claude-code) -- 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]
