Minimal Documentation Changes #17
Merged
Conversation
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
Signed-off-by: Jeremy Parr-Pearson <[email protected]>
Signed-off-by: Jeremy Parr-Pearson <[email protected]>
Signed-off-by: Jeremy Parr-Pearson <[email protected]>
Signed-off-by: Jeremy Parr-Pearson <[email protected]>
Signed-off-by: Jeremy Parr-Pearson <[email protected]>
Signed-off-by: Jeremy Parr-Pearson <[email protected]>
Signed-off-by: Jeremy Parr-Pearson <[email protected]>
jeremyprime
commented
Oct 30, 2025
Comment on lines
+9
to
+22
| * Connection package as low-level abstraction across multiple drivers ([Valkey GLIDE](https://github.com/valkey-io/valkey-glide), [Lettuce](https://github.com/lettuce-io/lettuce-core), and [Jedis](https://github.com/redis/jedis)). | ||
| * Exception translation to Spring's portable Data Access exception hierarchy for driver exceptions. | ||
| * `ValkeyTemplate` that provides a high level abstraction for performing various Valkey operations, exception translation and serialization support. | ||
| * Pubsub support (such as a MessageListenerContainer for message-driven POJOs). | ||
| * Valkey Sentinel and Valkey Cluster support. | ||
| * Reactive API using Lettuce. | ||
| * JDK, String, JSON and Spring Object/XML mapping serializers. | ||
| * JDK Collection implementations on top of Valkey. | ||
| * Atomic counter support classes. | ||
| * Sorting and Pipelining functionality. | ||
| * Dedicated support for SORT, SORT/GET pattern and returned bulk values. | ||
| * Valkey implementation for Spring cache abstraction. | ||
| * Automatic implementation of `Repository` interfaces including support for custom finder methods using `@EnableValkeyRepositories`. | ||
| * CDI support for repositories. |
Collaborator
Author
There was a problem hiding this comment.
This is just a rebranding of the existing Redis feature list. Wasn't sure which items to remove or alter.
jeremyprime
commented
Oct 30, 2025
| While updating dependencies and adding new configurations must be done manually, the renaming of packages and classes can be automated with a script. Here's an example using `sed`: | ||
|
|
||
| ```bash | ||
| find path/to/project -type f \( -name "*.java" -o -name "*.properties" -o -name "*.yml" \) -exec sed -i \ |
Collaborator
Author
There was a problem hiding this comment.
It's hard to come up with a comprehensive script since there are so many classes, and some things like dependency management and Spring configuration are not simple replacements. But I was able to use this command to get most of the way there by updating package names and most class names when I was testing migration of a few example projects.
ikolomi
approved these changes
Nov 2, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Updated top-level
README.md(changed fromadoctomd, and updated to reflect Valkey instead of Redis), removed Redis-specificCONTRIBUTING.adocandSECURITY.adoc, and addedMIGRATION.md.This PR closes #7.
Testing
Tested following the migration guide steps for some custom examples, as well as a set of Spring Data Redis examples.
Current limitations:
Next Steps
Next up is to rebrand/rewrite the full documentation (see
src/main/antora). This will require aligning with how other Valkey documentation is generated and published.