chore: update documentation links for 1.0.0 release - #5290
Merged
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?
N/A — release chore for 1.0.0.
Rationale for this change
Publishes the 1.0.0 user guide and makes it the default (current stable) version in the
documentation, following the "Publishing Documentation" step of the
release process.
Mirrors the pattern from #4698 (0.17.0) and #4314 (0.16.0).
What changes are included in this PR?
docs/generate-versions.py:latest_released_version = "1.0.0", and0.17.0moves intoprevious_versions(older guides are kept, per docs: restore 0.13 user guide dropped in 0.17 release #4704).
docs/build.sh: clean up the locally clonedcomet-0.17andcomet-1.0branch dirs before regenerating.comet-0.17was missing because the rm list historically only trackedprevious_versions; without a line percloned version a rebuild silently reuses the stale clone from the previous run.
docs/source/user-guide/index.md: current stable release is now 1.0.x, sidebar entry points at1.0/index.docs/source/user-guide/older-versions.md: point the "current stable release" link at 1.0 and add 0.17.x to the list.docs/source/contributor-guide/release_process.md: refresh the "Publishing Documentation" instructions, whichstill referred to
docs/source/index.rstand the_toc.user-guide-links-versionedsection — neither exists sincethe sidebar overhaul. The section now lists the four files actually involved.
Not included (separate follow-ups per the release process): bringing
docs/source/changelog/1.0.0.mdintomain,which happens after the vote passes.
How are these changes tested?
branch-1.0exists and has generated (frozen) user guide content underdocs/source/user-guide/latest/, includingindex.rstand the per-Spark-version compatibility pages, so the versioned guide will render. The docs build itselfis exercised by the documentation CI workflow.