docs: bring user-facing versions up to the 0.20.2 release train - #182
Merged
Conversation
fupelaqu
marked this pull request as ready for review
July 31, 2026 21:23
Contributor
Author
|
Companion web PR: SOFTNETWORK-APP/softclient4es-web#29 (same bump for the public site, incl. the four download buttons and their |
Every version a reader is told to install now matches what is actually published: engine / java-client 0.20.0 -> 0.20.2 community-extensions 0.2.0 -> 0.2.2 (0.2.3 does NOT exist) arrow-extensions -> 0.2.3 jdbc / adbc / arrow-flight-sql 0.2.1 -> 0.2.3 (all four ES lines) Each (artifact, version) pair was checked against the JFrog listing API before editing, and the extensions are deliberately asymmetric: the community line stops at 0.2.2 while arrow is at 0.2.3. Beyond the mechanical bump: - repl.md's `--list-versions` sample advertised "0.20.2 / 0.20.3", and the Installation Examples below it then installed 0.16.0 — so one page showed three different ideas of what exists, one of them a version that never shipped. The sample now lists the real bundle line (0.20.1 / 0.20.2) and the examples install 0.20.1. This is not cosmetic: a version with no -all bundle silently falls back to the plain artifact, which has no arrow extensions and therefore no cross-index JOIN — the docs were demonstrating the path that loses the headline feature. - README's sbt setup listed community-extensions but never arrow-extensions, even though repl.md calls the latter required for JOINs. Added, with the Java 11+ note. - install.sh: the --help example pinned 0.20.0 (no bundle -> same fallback trap) and a comment still referenced the phantom 0.20.3. Historical statements were left alone: "since v0.14.0" feature markers and CONTRIBUTING's release-process example describe the past, not what to install. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…on with no bundle Same trap the core docs commit fixes elsewhere: 0.20.0 has no -all bundle, so this example quietly demonstrates the fallback to the plain artifact, which carries no extensions and therefore no cross-index JOIN. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
fupelaqu
force-pushed
the
docs/versions-0.20.2
branch
from
July 31, 2026 21:26
2a33390 to
e673f65
Compare
Contributor
Author
|
Rebased onto main (now that #180 is merged) and picked up one extra commit. That second commit fixes Companion web PR SOFTNETWORK-APP/softclient4es-web#29 is already merged, so merging this closes the MD/MDX gap. |
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.
Brings every user-facing version reference in the core docs up to what the 0.20.2 release train actually published.
Versions
softclient4es8-java-clientsoftclient4es-community-extensionssoftclient4es-arrow-extensionssoftclient4es{6,7,8,9}-jdbc-driversoftclient4es{6,7,8,9}-adbc-driversoftclient4es{6,7,8,9}-arrow-flight-sqlsoftclient4es-jdbc-driver_2.13(%%form)Every pair was checked against the JFrog listing API before editing. Note the deliberate asymmetry: community-extensions stops at 0.2.2 — 0.2.3 does not exist for it — while arrow-extensions is at 0.2.3. Review independently confirmed both, and that arrow-extensions 0.2.3's POM does not depend on community-extensions, so the mixed pairing is safe.
Beyond the mechanical bump
repl.mdcontradicted itself three ways. The--list-versionssample advertised "0.20.2 / 0.20.3" (0.20.3 never shipped), and the Installation Examples thirty lines below then installed0.16.0. So one page showed three different ideas of what exists. The sample now lists the real bundle line (0.20.1 / 0.20.2) and the examples install 0.20.1.This is not cosmetic. Per install.sh, a version with no matching
-allbundle logsNo -all bundle for version … falling back to the plain artifact, and per repl.md's own text the plain artifact has no arrow extensions and therefore no cross-index JOIN. The docs were handing users a copy-paste command that silently loses the headline feature.README's sbt block never mentioned arrow-extensions, only community-extensions — while repl.md calls arrow-extensions required for cross-index JOIN. Added, with the Java 11+ note.
install.sh: the--helpexample pinned 0.20.0 (same no-bundle fallback trap) and a comment still referenced the phantom 0.20.3.Deliberately unchanged
Historical statements:
documentation/sql/*"since v0.14.0" feature markers and CONTRIBUTING's release-process example describe the past, not what to install. Rewriting them would make them false.Verification
Review swept both this repo and the web repo over all tracked files and found no remaining stale reference; confirmed every bumped pair resolves on JFrog; and checked MD↔MDX parity (versions, artifact names, Java floor, install commands all agree). The one divergence it found — arrow-extensions described as "optional" on the web while this PR calls it required — is fixed in the companion web PR.
The
install.ps1stale example the review also flagged is fixed in #180 instead, which owns that file, to avoid a merge conflict.Companion
softclient4es-web
docs/versions-0.20.2— same bump for the public site, including the four download buttons and theirdata-versionanalytics attributes.