Skip to content

Valkey Quickstart Guide #280

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

sarthakaggarwal97
Copy link
Contributor

This change aims to improve quickstart guide for Valkey.

@rlunar
Copy link

rlunar commented Jul 9, 2025

Overall looks, good but there's a few things I'll like to update with specifics but gist is should we use RESP3? Do we want to double check specific Linux distro versions that do include Valkey.

@sarthakaggarwal97
Copy link
Contributor Author

@rlunar as discussed offline, we are not planning to add things around RESP3. Do let me know if you have any more comments on the PR! It would be nice to get this merged.

Copy link
Contributor

@zuiderkwast zuiderkwast left a comment

Choose a reason for hiding this comment

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

Not a full review. Just noticed some structural details.

@hpatro
Copy link
Contributor

hpatro commented Jul 15, 2025

@rlunar Do you want to take a pass at this?

Copy link

@rlunar rlunar left a comment

Choose a reason for hiding this comment

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

Looks good, see my comments

```
$ valkey-server
Copy link

Choose a reason for hiding this comment

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

This works for first party package, should we also have the docker version?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I am not sure we need to have a docker version. We can use valkey-server as is right? Am I missing something?

Copy link

Choose a reason for hiding this comment

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

If you go with the flow of the page, you see the docker run; but then you're not longer using docker, I think we need to make it as easy as possible and that's by using the container image and don't expect users to have to install dependencies and the binary or having to compile; we can always have a separate section to get started from scratch.

Signed-off-by: Sarthak Aggarwal <sarthagg@amazon.com>
Signed-off-by: Sarthak Aggarwal <sarthagg@amazon.com>
Signed-off-by: Sarthak Aggarwal <sarthagg@amazon.com>
Signed-off-by: Sarthak Aggarwal <sarthagg@amazon.com>
Signed-off-by: Sarthak Aggarwal <sarthagg@amazon.com>

The examples in this article refer to a simple bicycle inventory.
Valkey is an open-source, high-performance in-memory key/value data store designed for speed and reliability. It supports a variety of workloads – from caching frequently accessed data to acting as a message broker – and can even function as a primary NoSQL database. Backed by the Linux Foundation, Valkey is guaranteed to remain fully open source.
Copy link
Member

Choose a reason for hiding this comment

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

this feels like a repetition of https://valkey.io/topics/introduction, which is right above this quick start section.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

let me think if I can rewrite this. or you think we remove this totally?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have removed it and linked it to introduction.md

The first step is to connect to Valkey. There are client connectors for [most programming languages](../clients/).
You can also connect using [valkey-cli](cli.md), the command line interface.
The following example shows how to connect to a Valkey server that runs on localhost (`-h 127.0.0.1`) and listens on the default port (`-p 6379`):
Getting Valkey up and running is straightforward. Follow these steps to install the server, start it, and connect:
Copy link
Member

Choose a reason for hiding this comment

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

similarly, would it be better to link to https://valkey.io/topics/installation? maybe keep a super short one-liner command and defer the more advanced setup to the installation page? actually I feel that running Valkey in a brower via the Try Valkey link would be even quicker for someone who wants to try out the basic functionality.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

so, I added installation steps for docker because they were missing from the installation.md file. But I agree, I can probably remove this installation part and link it to try valkey. Let me work on that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

made some change please take a look!

Signed-off-by: Sarthak Aggarwal <sarthagg@amazon.com>
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

Successfully merging this pull request may close these issues.

5 participants