martin-g commented on code in PR #24792: URL: https://github.com/apache/datafusion/pull/24792#discussion_r4228383620
########## dev/release/README.md: ########## @@ -313,6 +313,68 @@ git tag 55.2.0 git push apache 55.2.0 ``` +#### Publish the versioned documentation + +**1. Build the documentation from the release tagm using the a configuration Review Comment: ```suggestion **1. Build the documentation from the release tag using the a configuration ``` ########## dev/release/README.md: ########## @@ -313,6 +313,68 @@ git tag 55.2.0 git push apache 55.2.0 ``` +#### Publish the versioned documentation + +**1. Build the documentation from the release tagm using the a configuration +overlay (`docs/scripts/release/conf.py`) from the main checkout. For example, +for `55.0.0`, from the repository root: + +```shell +export DATAFUSION_DOCS_OVERLAY="$PWD/docs/scripts/release" +git fetch apache tag 55.0.0 +git worktree add --detach /tmp/datafusion-55.0.0 55.0.0 +cd /tmp/datafusion-55.0.0/docs +DATAFUSION_DOCS_SOURCE="$PWD/source" DATAFUSION_DOCS_VERSION=55.0.0 \ + SPHINXOPTS="-W -c $DATAFUSION_DOCS_OVERLAY" \ + uv run --package datafusion-docs --with sphinx-sitemap ./build.sh +cd - +``` + +Notes: +1. You need ot use an absolute path to the overlay in your current checkout. +2. The `--with sphinx-sitemap` option supplies the sitemap extension for older tags. + +prepare a PR targeting `asf-site` that contains the +documentation for this release. (For example +[#25881](https://github.com/apache/datafusion/pull/25881)). + +```shell +mkdir -p docs/build/html/versions/55.0.0 +rsync -a /tmp/datafusion-55.0.0/docs/build/html/ docs/build/html/versions/55.0.0/ +python3 -m http.server --directory docs/build/html 8000 +``` + +**2. Add the built site to the `asf-site` branch.** Open a PR against +`asf-site` that adds the release under `versions/<version>/`: + +```shell +git fetch apache asf-site +git worktree add -b docs/publish-55.0.0 /tmp/datafusion-asf-site apache/asf-site +rsync -a --exclude '/.buildinfo' \ + /tmp/datafusion-55.0.0/docs/build/html/ \ + /tmp/datafusion-asf-site/versions/55.0.0/ +cd /tmp/datafusion-asf-site +git add versions/55.0.0 +git commit -m "Publish documentation for 55.0.0" +git push origin docs/publish-55.0.0 +``` + +The release is live at `https://datafusion.apache.org/versions/55.0.0/` once +the PR is merged. + +**3. Add the release to the version picker.** Open a PR against `main` that +adds the release to `docs/source/_static/versions.json`. Put the new release +first and move `"preferred": true` to it, so that it is the default shown. Review Comment: I see no `"preferred": true` currently at https://github.com/apache/datafusion/pull/24792/changes#diff-99ab87d9590045ea1e68507c78e72d2034bf0505d2b96edd222b3fe0e97fea1aR2-R6 -- 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]
