Conversation
Sweep of the user guide against everything merged since 1.0.0 branched (af534e0), per the release preparation step in the release process. Correct statements that no longer match the code: the CI coverage table (only Spark 4.1 is gated before merge since the non-default profiles moved to the nightly run), the Spark 3.x Parquet limitations Comet has long since closed, cast/JSON/regex/array notes that say "falls back" where Comet now routes through the codegen dispatcher, S3 region auto-detection, Iceberg NOT IN pushdown, tokio thread defaults, shuffle and scan metric names, and a Kubernetes example that pointed at a Java 11 / Spark 3.5 image and left Comet disabled for lack of off-heap memory. Remove known-divergence entries that 1.1.0 fixed (boolean to decimal cast, explicit positive timestamp years, the ABFS object store cache key, most of the ANSI error-message items), and document new 1.1.0 behaviour: the experimental in-memory cache, the native Iceberg writer and the WRITE credential access mode, nested hash shuffle keys, BINARY sort-merge join keys, aggregate spill and memory metrics, native TIME functions, Variant-bearing tables whose Variant columns are not read, and the missing expression and plan-node rows. Add an "Upgrading to Comet 1.1.0" section to the upgrade guide, and drop the release-process notes about tag pushes publishing a Docker image, since that workflow was removed in apache#4241.
23 tasks
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
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.
Which issue does this PR close?
Part of #5327.
Rationale for this change
The release process asks for a review of the user guide before the release branch is cut. I went through every page under
docs/source/user-guide/latest/against the changes merged since 1.0.0 branched (af534e0), and checked each statement I touched against the code.What changes are included in this PR?
Most of the diff corrects statements that stopped being true. The CI table in the installation guide still said every Spark version is tested on every change, but since #5963 only Spark 4.1 is gated before merge and the other profiles run nightly. The Spark 3.4/3.5 "known limitations" described Parquet reads that Comet has rejected, like Spark does, since before 1.0. A number of expression notes, and the cast legend, said "falls back" where Comet now routes the case through the codegen dispatcher by default. The S3 region and Iceberg
NOT INpushdown descriptions were wrong, as were the tokio thread defaults and several shuffle and scan metric names. The Kubernetes example pointed at a Java 11 / Spark 3.5 image and set no off-heap memory, which leaves Comet disabled.The compatibility guide listed divergences that 1.1.0 fixed: the boolean to decimal cast, explicit positive timestamp years, the ABFS object store cache key, and most of the ANSI error-message items. Those entries are removed.
It also documents 1.1.0 behaviour that had no coverage. That includes the experimental in-memory cache, the native Iceberg writer (including the credential provider's
WRITEaccess mode), nested hash shuffle keys,BINARYsort-merge join keys, and the aggregate spill and memory metrics. It also covers native TIME functions, scans of tables whose Variant columns aren't read, and missing expression and plan-node rows. The upgrade guide gets an "Upgrading to Comet 1.1.0" section. Diffing the generated config reference against 1.0.0 shows no removed keys, no changed defaults, and nospark.comet.legacy.*keys, so the section says no behavior change needs a legacy key, and notes that JDK 17 is now required. The release process also loses its two notes about tag pushes publishing a Docker image, since that workflow was removed in #4241.A few things are deliberately left alone:
expressions.mdtocompatibility/expressions/<category>.mddon't resolve on the published site, because those pages only exist underspark-<ver>/at build time. 1.0.0 has the same problem. Should they point at the Spark 4.1 pages or at the index?from_unixtimeexample inunderstanding-comet-plans.mdno longer falls back, and a replacement needs real plan output.scalaUDF.codegen.enabledandmemoryOverheadconfig descriptions, and theTruncTimestampfallback reason. Those are code changes, so a follow-up.How are these changes tested?
This is documentation only. Each corrected or added statement was checked against the code at dd68a53: serde support levels, config definitions and defaults, operator node names, and metric names. Prettier passes. I haven't run the full docs build, but a script checked the relative links and anchors in the changed pages. The only targets that don't resolve are the pre-existing category links mentioned above.