Skip to content

docs: [branch-1.2] generate docs for the 1.2.0 release - #7292

Merged
andygrove merged 2 commits into
apache:branch-1.2from
andygrove:docs-generate-1-2-0
Oct 28, 2026
Merged

andygrove merged 2 commits into
apache:branch-1.2from
andygrove:docs-generate-1-2-0

Conversation

@andygrove

@andygrove andygrove commented Oct 28, 2026 •

Copy link
Copy Markdown
Member

Which issue does this PR close?

Part of #6550. This is the "Generate release documentation" step of the release process.

Rationale for this change

On main, docs/source/user-guide/latest/ holds template markers and CI fills them at publish time. A release branch commits the generated content, so the archived docs for 1.2.0 render real tables.

What changes are included in this PR?

The output of ./dev/generate-release-docs.sh on branch-1.2 at 286be994d2 (after #7290), with no hand edits except the prettier fix below:

  • configs.md: the generated config tables for all ten categories.
  • expressions.md: the Implementation column, refreshed from the serde registered on this branch. The 18 changed lines bring it in line with the code. The values follow the same pattern as the 1.1.0 release docs, for example mode and hour are —, << is Native and cast is Hybrid.
  • compatibility/expressions/spark-3.4, spark-3.5, spark-4.0, spark-4.1 and spark-4.2: the per-Spark-version compatibility pages, 10 files each. 1.1.0 had four of these directories, and 4.2 is new.

The script ran one Maven build per profile, and all five succeeded. A second commit adds one blank line before <!--END:EXPR_COMPAT--> in 40 of the generated pages. The script formats with whichever prettier npx finds locally, and the CI check installs the latest prettier, which wants that blank line. Prettier 3.9.10 passes on docs/source/user-guide/latest/ with both commits.

How are these changes tested?

The files are generated, so there is nothing to run beyond the script itself. I did not read through the generated tables line by line.

#7291 adds one entry to the changelog and doesn't touch these files, so merge order doesn't matter. Anything else that changes a config's description or default, or the supported expressions, needs these docs regenerated.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 28, 2026

@mbutrovich mbutrovich left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the mechanism mostly, not the actual product too closely. Thanks @andygrove!

@andygrove
andygrove merged commit 7462460 into apache:branch-1.2 Oct 28, 2026
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants