Skip to content

Valkey Bundle Getting Started Guide #314

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

Merged
merged 8 commits into from
Jul 16, 2025

Conversation

Nikhil-Manglore
Copy link
Member

This is the getting started guide for Valkey Bundle. The commands will have to be updated once the name is changed from Valkey Extensions to Valkey Bundle.

@sarthakaggarwal97
Copy link
Contributor

sarthakaggarwal97 commented Jun 18, 2025

This still pulls up the valkey-extensions from docker. Do we know the plan to update the name in docker as well to valkey-bundle. @roshkhatri might know more about this.

I think this PR will change the name in docker as well: valkey-io/valkey-bundle#27

@makubo-aws
Copy link
Contributor

Spelling check looks fine.

Other than updating valkey-extensions to valkey-bundle looks good

@Nikhil-Manglore Nikhil-Manglore self-assigned this Jun 20, 2025
Copy link
Member

@madolson madolson left a comment

Choose a reason for hiding this comment

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

There is a lot of overlap between this and just running the normal container. Should we have a single doc for how to run with a container? (Most of this content is still fine, but just wondering out allowed if we should generalize 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.

Added a few comments to improve clarity.

@Nikhil-Manglore
Copy link
Member Author

Nikhil-Manglore commented Jul 9, 2025

There is a lot of overlap between this and just running the normal container. Should we have a single doc for how to run with a container? (Most of this content is still fine, but just wondering out allowed if we should generalize this)

I agree that there is overlap with how to run a container. I think maybe we can rename this guide to something along the lines of "getting started with valkey containers". Then we start out with explaining how to start docker containers for valkey. Then we can have a separate section after where we explain the extra bundle stuff.

On the other hand, I know that the getting started guide for Valkey already explains setting up the docker container as well. So maybe we could just keep this as is and consolidate everything about getting started with the bundle, from scratch, in this guide. I don't really have a preference but I know that the valkey bundle blog and the dockerhub description both explain setting up the container. @rlunar What are your thoughts?

@rlunar
Copy link

rlunar commented Jul 11, 2025

I agree that there is overlap with how to run a container. I think maybe we can rename this guide to something along the lines of "getting started with valkey containers". Then we start out with explaining how to start docker containers for valkey. Then we can have a separate section after where we explain the extra bundle stuff.

On the other hand, I know that the getting started guide for Valkey already explains setting up the docker container as well. So maybe we could just keep this as is and consolidate everything about getting started with the bundle, from scratch, in this guide. I don't really have a preference but I know that the valkey bundle blog and the dockerhub description both explain setting up the container. @rlunar What are your thoughts?

I know there's overlap but I like every Getting Started Page to stand on its own; as an end user I don't want to jump around to find the bits and pieces to make things work; as a new user I would like as much info as possible, as an experienced user I'll just skim through everything I know and move on quickly to the new parts.

If the persistence or logs aren't any different from the standalone then we can cut this part; besides that I'm OK to move on and iterate over time on this guide.

@Nikhil-Manglore Nikhil-Manglore force-pushed the valkey-extensions-docs branch from ba9c24e to e0da4c5 Compare July 11, 2025 18:38
Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Nikhil Manglore <[email protected]>
Signed-off-by: Nikhil Manglore <[email protected]>
@Nikhil-Manglore Nikhil-Manglore force-pushed the valkey-extensions-docs branch 2 times, most recently from 680b468 to b54899c Compare July 14, 2025 19:52
@stockholmux stockholmux merged commit d32d4da into valkey-io:main Jul 16, 2025
4 checks passed
@Nikhil-Manglore Nikhil-Manglore deleted the valkey-extensions-docs branch July 16, 2025 18:35
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.

6 participants