Skip to content

docs: add Jedis 4.x compatibility layer migration guide - #289

Open
Aryex wants to merge 1 commit into
mainfrom
alexl/agent/jedis-v4-migration-docs
Open

docs: add Jedis 4.x compatibility layer migration guide#289
Aryex wants to merge 1 commit into
mainfrom
alexl/agent/jedis-v4-migration-docs

Conversation

@Aryex

@Aryex Aryex commented Jul 26, 2026

Copy link
Copy Markdown
Collaborator

Summary

Adds documentation for the new Jedis 4.x Compatibility Layer, a drop-in replacement for Jedis 4.0.x–4.4.x applications migrating to Valkey GLIDE.

⚠️ Attention: This PR was generated automatically. Verify that all relevant pages have been updated.

Source Commits

  • f7394d2 — feat(jedis-v4): add jedis-v4 migration layer (#5751)

Changes

  • Added new documentation section: migration/java/jedis/jedis-4-compatibility-layer/
    • Overview page explaining why a separate 4.x layer exists and key differences from 5.x layer
    • Step-by-step migration guide with Gradle/Maven dependency examples and platform classifiers
    • Supported features page covering client types, commands, and limitations
    • Configuration mapping page showing how Jedis 4.x configs translate to GLIDE
  • Updated migration/java/jedis/index.mdx to add a LinkCard for the Jedis 4.x layer
  • Updated astro.config.mjs sidebar to include the new section

Context

The source commit adds a new Gradle module jedis-4-compatibility under java/ that provides Jedis 4.x API compatibility for Valkey GLIDE. This is separate from the existing jedis-compatibility module (targeting Jedis 5.x) because Jedis 5 introduced breaking type changes (JedisPooled generics, RESP3 APIs). Applications still on Jedis 4.x need this dedicated compatibility artifact.

cc @prashanna-frsh


This PR was generated by the automated documentation pipeline.

@Aryex Aryex added AI Generated documentation Improvements or additions to documentation java jedis labels Jul 26, 2026
@Aryex
Aryex force-pushed the alexl/agent/jedis-v4-migration-docs branch from 6ef10a0 to e522629 Compare July 26, 2026 21:27
@Aryex
Aryex requested review from jeremyprime and xShinnRyuu July 27, 2026 14:48
@Aryex Aryex self-assigned this Jul 27, 2026
Signed-off-by: kiro-agent <kiro-agent@users.noreply.github.com>
@Aryex
Aryex force-pushed the alexl/agent/jedis-v4-migration-docs branch from e522629 to dd76c66 Compare July 27, 2026 14:48
@Aryex
Aryex marked this pull request as ready for review July 27, 2026 14:48
@jeremyprime
jeremyprime requested review from prateek-kumar-improving and removed request for jeremyprime July 27, 2026 15:36
```diff lang="groovy"
dependencies {
- implementation 'redis.clients:jedis:4.4.8'
+ implementation group: 'io.valkey', name: 'valkey-glide-jedis-4-compatibility', version: '2.1.0', classifier: 'linux-x86_64'

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The version in this file (2.1.0) is outdated. We should use a placeholder or pull from versions.ts. See other uses of versions throughout the docs to ensure consistent.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AI Generated documentation Improvements or additions to documentation java jedis

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants