docs: add full-site version snapshots - #24792
Draft
yiaany wants to merge 2 commits into
Draft
Conversation
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?
Rationale for this change
The documentation published at https://datafusion.apache.org/ currently follows
main, so it can describe behavior that differs from released DataFusionversions.
This PR introduces a complete immutable documentation snapshot for DataFusion
55.0.0, while keeping the root site on the latestmaindocumentation. Theapproach follows the model discussed in #17071: build the complete tagged site
into one version directory and use the PyData Sphinx Theme version switcher.
What changes are included in this PR?
Developmentand55.0.0.55.0.0tag into/versions/55.0.0/.55.0.0resolves to commitd5552342012888b7d1a3ab88d92e3d292fc0cde0."has not been released yet" sentence.
mainorlatestcontent.
documentation deployment.
published snapshot.
This PR does not publish generated documentation, modify
asf-site, backfillolder releases, add
latestorstablealiases, or automate future releasepublication.
Are these changes tested?
Yes. I ran:
git diff --check./ci/scripts/doc_prettier_check.shbash ci/scripts/markdown_link_check.sh./ci/scripts/typos_check.sh./ci/scripts/license_header.shcargo fmt --all -- --checkcargo clippy --all-targets --all-features -- -D warnings./dev/rust_lint.sh55.0.0full-site snapshot buildmobile layout, and JavaScript-disabled release identification
The final snapshot contains no
.doctrees,.buildinfo, temporary build paths,or generated artifacts tracked in Git.
Are there any user-facing changes?
Yes.
The current documentation remains at the site root. Users can switch between:
Development: https://datafusion.apache.org/55.0.0: https://datafusion.apache.org/versions/55.0.0/The initial
55.0.0snapshot must be published manually.Bootstrap coordination
This PR intentionally remains a draft until maintainers choose the initial
publication sequence.
The current
asf-sitebranch does not yet containversions/55.0.0/, anddeployment validation intentionally fails closed until the snapshot exists.
Could a maintainer confirm which bootstrap procedure should be used?
snapshot manually.
running or queued, publish the snapshot, merge this PR, and verify that the
new deployment retains it.
I have not modified or published anything to
asf-site.I reviewed the implementation end-to-end and can explain the exact-tag build,
publication boundary, archive retention, validator, and deployment sequence
during review.