Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Documentation About Valkey Compatibility #2836

Open
asafpamzn opened this issue Jan 13, 2025 · 3 comments
Open

Add Documentation About Valkey Compatibility #2836

asafpamzn opened this issue Jan 13, 2025 · 3 comments

Comments

@asafpamzn
Copy link

I’d like to suggest adding a note to the documentation clarifying that StackExchange.Redis is compatible with Valkey. This information could be really helpful for developers using Valkey in their projects, saving them time and ensuring they are confident in their choice of StackExchange.Redis.

If this is already documented somewhere, perhaps it could be made more prominent or linked from the main documentation pages.

@mgravell
Copy link
Collaborator

mgravell commented Jan 13, 2025

AFAIK we don't really maintain a list of verified servers. Should we? Possibly, but that then means we need verify those servers, on an ongoing basis. In theory it should work with any RESP backend; I'm happy to add a few words along those lines on the front page, perhaps listing a few contenders (Redis, Garnet, Valkey, AWS, Azure offerings, etc). Some of those can be a pain to test, especially when we consider the entire SKU matrix of versions/tiers/etc - and the need for subscriptions/credentials for hosted offerings. Unless we invest significant time building a validation matrix, I'd be wary of adding too definitive a statement, hence my preference to be a vague hand-wavey "hey, it'll probably work; if not - let us know".

so... does it work on Valkey?

@asafpamzn
Copy link
Author

Thanks for the quick reply.
I understand your concerns about maintaining a list of verified servers and the challenges it presents. Your suggestion for a more general approach is reasonable. Maybe a brief section to the documentation mentioning that StackExchange.Redis is designed to work with RESP-compatible backends including Redis, Garnet, Valkey, and cloud offerings as examples, without implying full verification.

I think that explicitly mentioning the backends is important since some users don't know what RESP is.

mgravell added a commit that referenced this issue Jan 13, 2025
@mgravell
Copy link
Collaborator

Words proposed ^^^

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants