andygrove opened a new issue, #1938: URL: https://github.com/apache/datafusion-ballista/issues/1938
Ballista has no per-release upgrade guide. Upstream DataFusion maintains one under `docs/source/library-user-guide/upgrading/`, with one page per release documenting the breaking changes and the action a user must take when upgrading. Ballista would benefit from the same. Proposal: - Add a `docs/source/upgrading/` directory with an `index.rst` toctree and one Markdown page per release, wired into the top-level docs navigation. - Cover **breaking changes only** (breaking API/trait/signature changes, removed/renamed configuration keys or CLI flags, changed defaults that alter query plans or results, and wire/serialization-format changes). - Because Ballista serves both **cluster operators** and **library/embedding users**, separate the two audiences within each release page. - Launch with a `54.0.0` page covering the breaking changes since `53.0.0`. The changelog (auto-generated PR lists) is not a substitute — an upgrade guide is hand-curated and tells users what action to take. -- 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]
