This is an automated email from the ASF dual-hosted git repository.
andygrove 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 4ad15fe076 chore: update documentation links for 1.0.0 release (#5290)
4ad15fe076 is described below
commit 4ad15fe0762091158505f1288f1708dc0e95e0d0
Author: Andy Grove <[email protected]>
AuthorDate: Fri Aug 7 14:04:55 2026 -0600
chore: update documentation links for 1.0.0 release (#5290)
---
docs/build.sh | 2 ++
docs/generate-versions.py | 4 ++--
docs/source/contributor-guide/release_process.md | 18 ++++++++++++++----
docs/source/user-guide/index.md | 4 ++--
docs/source/user-guide/older-versions.md | 3 ++-
5 files changed, 22 insertions(+), 9 deletions(-)
diff --git a/docs/build.sh b/docs/build.sh
index 84cc3f7180..76f4db4cf0 100755
--- a/docs/build.sh
+++ b/docs/build.sh
@@ -29,6 +29,8 @@ rm -rf comet-0.13
rm -rf comet-0.14
rm -rf comet-0.15
rm -rf comet-0.16
+rm -rf comet-0.17
+rm -rf comet-1.0
python3 generate-versions.py
# Generate dynamic content (configs, compatibility matrices) for latest docs
diff --git a/docs/generate-versions.py b/docs/generate-versions.py
index f7c604bf0e..3ba6aee12e 100644
--- a/docs/generate-versions.py
+++ b/docs/generate-versions.py
@@ -154,6 +154,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.17.0"
- previous_versions = ["0.13.0", "0.14.0", "0.15.0", "0.16.0"]
+ latest_released_version = "1.0.0"
+ previous_versions = ["0.13.0", "0.14.0", "0.15.0", "0.16.0", "0.17.0"]
generate_docs(snapshot_version, latest_released_version, previous_versions)
\ No newline at end of file
diff --git a/docs/source/contributor-guide/release_process.md
b/docs/source/contributor-guide/release_process.md
index 58738be086..2cc430a148 100644
--- a/docs/source/contributor-guide/release_process.md
+++ b/docs/source/contributor-guide/release_process.md
@@ -285,15 +285,25 @@ it to GitHub Container Registry at
https://github.com/apache/datafusion-comet/pk
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.13`
-- Update the main method in `generate-versions.py`:
+- Update the main method in `generate-versions.py` to promote the new release
to the current one and move the
+ previously current release into the list of older versions:
```python
latest_released_version = "0.13.0"
- previous_versions = ["0.11.0", "0.12.0"]
+ previous_versions = ["0.10.0", "0.11.0", "0.12.0"]
```
+- Add a new line to `build.sh` to delete the locally cloned `comet-*` branch
for the new release e.g. `comet-0.13`.
+ Every version referenced in `generate-versions.py` needs a line here,
otherwise a rebuild reuses the stale clone
+ from the previous run.
+- Update `docs/source/user-guide/index.md`: change the "current stable
release" sentence and the versioned entry in
+ the toctree (e.g. `0.13.x (current) <0.13/index>`).
+- Update `docs/source/user-guide/older-versions.md`: point the "current stable
release" link at the new release and
+ add the previously current release to the toctree.
+
+Note that older user guides are kept rather than dropped, so the lists in
`generate-versions.py`, `build.sh`, and
+`older-versions.md` grow with each release.
+
Test the documentation build locally, following the instructions in
`docs/README.md`.
Once verified, create a PR against the main branch with these documentation
changes. After merging, the docs will be
diff --git a/docs/source/user-guide/index.md b/docs/source/user-guide/index.md
index c58ce1c201..85b129a435 100644
--- a/docs/source/user-guide/index.md
+++ b/docs/source/user-guide/index.md
@@ -22,7 +22,7 @@ under the License.
The Comet user guide covers installation, configuration, supported data
sources, supported operators
and expressions, and tuning advice for running Apache Spark with Comet
acceleration.
-The **current stable release** is 0.17.x. Most users should start there. The
**development snapshot**
+The **current stable release** is 1.0.x. Most users should start there. The
**development snapshot**
tracks the upcoming release and may include features and fixes that are not
yet generally available.
User guides for **older releases** are kept for reference under [Older
Versions](older-versions).
@@ -31,7 +31,7 @@ User guides for **older releases** are kept for reference
under [Older Versions]
:caption: User Guide
:hidden:
-0.17.x (current) <0.17/index>
+1.0.x (current) <1.0/index>
Development Snapshot <latest/index>
Older Versions <older-versions>
```
diff --git a/docs/source/user-guide/older-versions.md
b/docs/source/user-guide/older-versions.md
index 81c73be133..00d936be54 100644
--- a/docs/source/user-guide/older-versions.md
+++ b/docs/source/user-guide/older-versions.md
@@ -20,11 +20,12 @@ under the License.
# Older Versions
These user guides are kept for reference. They are not maintained: use the
-[current stable release](0.17/index) for production guidance.
+[current stable release](1.0/index) for production guidance.
```{toctree}
:maxdepth: 1
+0.17.x <0.17/index>
0.16.x <0.16/index>
0.15.x <0.15/index>
0.14.x <0.14/index>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
