NoahKusaba opened a new pull request, #2481: URL: https://github.com/apache/datafusion-ballista/pull/2481
# Rationale for this change `docs/developer/` sits outside the Sphinx `source/` tree, so it has never been published, yet #2038 and #2315 both added architecture docs to it. Separately, the `ballista-core`, `ballista-scheduler` and `ballista-executor` READMEs are their docs.rs landing pages via `include_str!`, and each was four lines long. # What changes are included in this PR? - Port the unique content of `docs/developer/architecture.md` into `contributors-guide/architecture.md`: the `SchedulerGrpc` method table and the Multi-partition tasks section. - **Delete `docs/developer/`.** Its diagram was dropped rather than ported: it labels arrows `ExecutePartition`, which is not an RPC in the current proto. This is the only change in the split that can't easily be undone, so please check nothing else in that directory is wanted. - Point `docs/README.md` at the contributors guide. - Write real READMEs for `ballista-core`, `ballista-scheduler` and `ballista-executor`: what each crate is, how to run it (including the three executor ports), how to use it as a library, and its Cargo features. - The client README points to the deployment guide for multi-executor setups, rather than half-describing them. # Are there any user-facing changes? Documentation only. The crate READMEs change what docs.rs shows for those three crates. Verified: `sphinx-build -W` is clean when combined with #2476. 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]
