You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datafusion.apache.org by mb...@apache.org on 2025/10/16 17:14:47 UTC
(datafusion-comet) branch main updated: docs: Publish 0.11.0 user guide (#2589)
This is an automated email from the ASF dual-hosted git repository.
mbutrovich pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion-comet.git
The following commit(s) were added to refs/heads/main by this push:
new 213a57b86 docs: Publish 0.11.0 user guide (#2589)
213a57b86 is described below
commit 213a57b86dfaaff927497fe207112e7766cf2deb
Author: Andy Grove <ag...@apache.org>
AuthorDate: Thu Oct 16 11:14:42 2025 -0600
docs: Publish 0.11.0 user guide (#2589)
---
dev/release/README.md | 18 ++++++++++++++++++
docs/build.sh | 1 +
docs/generate-versions.py | 4 ++--
docs/source/index.rst | 1 +
docs/source/user-guide/latest/installation.md | 15 +++++++++------
5 files changed, 31 insertions(+), 8 deletions(-)
diff --git a/dev/release/README.md b/dev/release/README.md
index dcab5a5fe..ed8d1e7ef 100644
--- a/dev/release/README.md
+++ b/dev/release/README.md
@@ -150,6 +150,24 @@ git push apache 0.1.0-rc1
Note that pushing a release candidate tag will trigger a GitHub workflow that will build a Docker image and publish
it to GitHub Container Registry at https://github.com/apache/datafusion-comet/pkgs/container/datafusion-comet
+### Publishing Documentation
+
+In `docs` directory:
+
+- Update `docs/source/index.rst` and add a new navigation menu link for the new release in the section `_toc.user-guide-links-versioned`
+- Add a new line to `build.sh` to delete the locally cloned `comet-*` branch for the new release e.g. `comet-0.11`
+- Update the main method in `generate-versions.py`:
+
+```python
+ latest_released_version = "0.11.0"
+ previous_versions = ["0.8.0", "0.9.1", "0.10.1"]
+```
+
+Test the documentation build locally, following the instructions in `docs/README.md`.
+
+Note that the download links in the installation guide will not work until the release is finalized, but having the
+documentation available could be useful for anyone testing out the release candidate during the voting period.
+
## Publishing the Release Candidate
This part of the process can mostly only be performed by a PMC member.
diff --git a/docs/build.sh b/docs/build.sh
index 8aa8ee559..f3f5245a2 100755
--- a/docs/build.sh
+++ b/docs/build.sh
@@ -28,6 +28,7 @@ cp -rf source/* temp/
rm -rf comet-0.8
rm -rf comet-0.9
rm -rf comet-0.10
+rm -rf comet-0.11
python3 generate-versions.py
# Remove overview pages (this used to be part of the user guide but is now a top level page)
diff --git a/docs/generate-versions.py b/docs/generate-versions.py
index fc21a24d3..e3a6fdd04 100644
--- a/docs/generate-versions.py
+++ b/docs/generate-versions.py
@@ -104,6 +104,6 @@ This is **out-of-date** documentation. The latest Comet release is version {late
if __name__ == "__main__":
print("Generating versioned user guide docs...")
snapshot_version = get_version_from_pom()
- latest_released_version = "0.10.0"
- previous_versions = ["0.8.0", "0.9.1"]
+ latest_released_version = "0.11.0"
+ previous_versions = ["0.8.0", "0.9.1", "0.10.1"]
generate_docs(snapshot_version, latest_released_version, previous_versions)
\ No newline at end of file
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 9d7da1dac..a6ef2fb24 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -50,6 +50,7 @@ as a native runtime to achieve improvement in terms of query efficiency and quer
:hidden:
0.12.0-SNAPSHOT <user-guide/latest/index>
+ 0.11.x <user-guide/0.11/index>
0.10.x <user-guide/0.10/index>
0.9.x <user-guide/0.9/index>
0.8.x <user-guide/0.8/index>
diff --git a/docs/source/user-guide/latest/installation.md b/docs/source/user-guide/latest/installation.md
index 40efdeb62..1d396fa41 100644
--- a/docs/source/user-guide/latest/installation.md
+++ b/docs/source/user-guide/latest/installation.md
@@ -59,12 +59,15 @@ Cloud Service Providers.
Comet jar files are available in [Maven Central](https://central.sonatype.com/namespace/org.apache.datafusion) for amd64 and arm64 architectures for Linux. For Apple macOS, it
is currently necessary to build from source.
-Here are the direct links for downloading the Comet 0.10.0 jar file.
-
-- [Comet plugin for Spark 3.4 / Scala 2.12](https://repo1.maven.org/maven2/org/apache/datafusion/comet-spark-spark3.4_2.12/0.10.0/comet-spark-spark3.4_2.12-0.10.0.jar)
-- [Comet plugin for Spark 3.4 / Scala 2.13](https://repo1.maven.org/maven2/org/apache/datafusion/comet-spark-spark3.4_2.13/0.10.0/comet-spark-spark3.4_2.13-0.10.0.jar)
-- [Comet plugin for Spark 3.5 / Scala 2.12](https://repo1.maven.org/maven2/org/apache/datafusion/comet-spark-spark3.5_2.12/0.10.0/comet-spark-spark3.5_2.12-0.10.0.jar)
-- [Comet plugin for Spark 3.5 / Scala 2.13](https://repo1.maven.org/maven2/org/apache/datafusion/comet-spark-spark3.5_2.13/0.10.0/comet-spark-spark3.5_2.13-0.10.0.jar)
+Here are the direct links for downloading the Comet $COMET_VERSION jar file. Note that these links are not valid if
+you are viewing the documentation for the latest `SNAPSHOT` release, or for the latest release while it is still going
+through the release vote. Release candidate jars can be found [here](https://repository.apache.org/#nexus-search;quick~org.apache.datafusion).
+
+- [Comet plugin for Spark 3.4 / Scala 2.12](https://repo1.maven.org/maven2/org/apache/datafusion/comet-spark-spark3.4_2.12/$COMET_VERSION/comet-spark-spark3.4_2.12-$COMET_VERSION.jar)
+- [Comet plugin for Spark 3.4 / Scala 2.13](https://repo1.maven.org/maven2/org/apache/datafusion/comet-spark-spark3.4_2.13/$COMET_VERSION/comet-spark-spark3.4_2.13-$COMET_VERSION.jar)
+- [Comet plugin for Spark 3.5 / Scala 2.12](https://repo1.maven.org/maven2/org/apache/datafusion/comet-spark-spark3.5_2.12/$COMET_VERSION/comet-spark-spark3.5_2.12-$COMET_VERSION.jar)
+- [Comet plugin for Spark 3.5 / Scala 2.13](https://repo1.maven.org/maven2/org/apache/datafusion/comet-spark-spark3.5_2.13/$COMET_VERSION/comet-spark-spark3.5_2.13-$COMET_VERSION.jar)
+- [Comet plugin for Spark 4.0 / Scala 2.13 (Experimental)](https://repo1.maven.org/maven2/org/apache/datafusion/comet-spark-spark4.0_2.13/$COMET_VERSION/comet-spark-spark4.0_2.13-$COMET_VERSION.jar)
## Building from source
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datafusion.apache.org
For additional commands, e-mail: commits-help@datafusion.apache.org