Skip to content

Commit 213a57b

Browse files
authored
docs: Publish 0.11.0 user guide (#2589)
1 parent 991e72d commit 213a57b

File tree

5 files changed

+31
-8
lines changed

5 files changed

+31
-8
lines changed

dev/release/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,24 @@ git push apache 0.1.0-rc1
150150
Note that pushing a release candidate tag will trigger a GitHub workflow that will build a Docker image and publish
151151
it to GitHub Container Registry at https://github.com/apache/datafusion-comet/pkgs/container/datafusion-comet
152152

153+
### Publishing Documentation
154+
155+
In `docs` directory:
156+
157+
- Update `docs/source/index.rst` and add a new navigation menu link for the new release in the section `_toc.user-guide-links-versioned`
158+
- Add a new line to `build.sh` to delete the locally cloned `comet-*` branch for the new release e.g. `comet-0.11`
159+
- Update the main method in `generate-versions.py`:
160+
161+
```python
162+
latest_released_version = "0.11.0"
163+
previous_versions = ["0.8.0", "0.9.1", "0.10.1"]
164+
```
165+
166+
Test the documentation build locally, following the instructions in `docs/README.md`.
167+
168+
Note that the download links in the installation guide will not work until the release is finalized, but having the
169+
documentation available could be useful for anyone testing out the release candidate during the voting period.
170+
153171
## Publishing the Release Candidate
154172

155173
This part of the process can mostly only be performed by a PMC member.

docs/build.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ cp -rf source/* temp/
2828
rm -rf comet-0.8
2929
rm -rf comet-0.9
3030
rm -rf comet-0.10
31+
rm -rf comet-0.11
3132
python3 generate-versions.py
3233

3334
# Remove overview pages (this used to be part of the user guide but is now a top level page)

docs/generate-versions.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,6 @@ def generate_docs(snapshot_version: str, latest_released_version: str, previous_
104104
if __name__ == "__main__":
105105
print("Generating versioned user guide docs...")
106106
snapshot_version = get_version_from_pom()
107-
latest_released_version = "0.10.0"
108-
previous_versions = ["0.8.0", "0.9.1"]
107+
latest_released_version = "0.11.0"
108+
previous_versions = ["0.8.0", "0.9.1", "0.10.1"]
109109
generate_docs(snapshot_version, latest_released_version, previous_versions)

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ as a native runtime to achieve improvement in terms of query efficiency and quer
5050
:hidden:
5151

5252
0.12.0-SNAPSHOT <user-guide/latest/index>
53+
0.11.x <user-guide/0.11/index>
5354
0.10.x <user-guide/0.10/index>
5455
0.9.x <user-guide/0.9/index>
5556
0.8.x <user-guide/0.8/index>

docs/source/user-guide/latest/installation.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,15 @@ Cloud Service Providers.
5959
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
6060
is currently necessary to build from source.
6161

62-
Here are the direct links for downloading the Comet 0.10.0 jar file.
63-
64-
- [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)
65-
- [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)
66-
- [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)
67-
- [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)
62+
Here are the direct links for downloading the Comet $COMET_VERSION jar file. Note that these links are not valid if
63+
you are viewing the documentation for the latest `SNAPSHOT` release, or for the latest release while it is still going
64+
through the release vote. Release candidate jars can be found [here](https://repository.apache.org/#nexus-search;quick~org.apache.datafusion).
65+
66+
- [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)
67+
- [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)
68+
- [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)
69+
- [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)
70+
- [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)
6871

6972
## Building from source
7073

0 commit comments

Comments
 (0)