Skip to content

[docs] Add quickstart guide and restructure README for v0.1.0#155

Open
bjosv wants to merge 10 commits intovalkey-io:mainfrom
Nordix:update-docs
Open

[docs] Add quickstart guide and restructure README for v0.1.0#155
bjosv wants to merge 10 commits intovalkey-io:mainfrom
Nordix:update-docs

Conversation

@bjosv
Copy link
Copy Markdown
Collaborator

@bjosv bjosv commented May 1, 2026

This PR closes #154

Summary

Restructures documentation to separate user and contributor paths in preparation for the v0.1.0 release.

  • README.md — Simplified to project overview with links to quickstart (users) and developer guide (contributors). Removed build-from-source boilerplate. Updated pre-release notice. Simplified license section.

  • docs/quickstart.md (new) — End-user guide covering: install operator, deploy a 3-shard cluster, verify health, connect with valkey-cli, and clean up.

  • docs/developer-guide.md — Added prerequisites, build/deploy from source, uninstall, and install bundle sections (moved from README). Added warning about make undeploy namespace behavior.

Checklist

Before submitting the PR make sure the following are checked:

  • This Pull Request is related to one issue.
  • Commit message explains what changed and why
  • Tests are added or updated.
  • Documentation files are updated.
  • I have run pre-commit locally (pre-commit run --all-files or hooks on commit)

bjosv added 4 commits May 1, 2026 01:03
Signed-off-by: Björn Svensson <bjorn.a.svensson@est.tech>
Signed-off-by: Björn Svensson <bjorn.a.svensson@est.tech>
Signed-off-by: Björn Svensson <bjorn.a.svensson@est.tech>
Signed-off-by: Björn Svensson <bjorn.a.svensson@est.tech>
Copy link
Copy Markdown
Collaborator

@jdheyburn jdheyburn left a comment

Choose a reason for hiding this comment

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

This is great thanks! Is there anything blocking it being ready for review? Is it having the helm chart created?

Comment thread README.md Outdated
Signed-off-by: Björn Svensson <bjorn.a.svensson@est.tech>
@bjosv bjosv marked this pull request as ready for review May 1, 2026 09:40
Signed-off-by: Björn Svensson <bjorn.a.svensson@est.tech>
@bjosv
Copy link
Copy Markdown
Collaborator Author

bjosv commented May 1, 2026

Is there anything blocking it being ready for review? Is it having the helm chart created?

I wanted to add some more known limitations to, just had to verify some stuff. But that is done now.

The quickstart guide should be able to describe how the operator helm chart in used when valkey-io/valkey-helm#162 is merged, but currently that is commented out and the "old" developer way is used. But that is only to install the operator as such, not a Valkey cluster.
Maybe we should have something related to that as well?
I'm not sure we can generated those templates, don't remember, or maybe we can be added later

bjosv added 2 commits May 1, 2026 11:58
Signed-off-by: Björn Svensson <bjorn.a.svensson@est.tech>
Signed-off-by: Björn Svensson <bjorn.a.svensson@est.tech>
Copy link
Copy Markdown
Contributor

@daanvinken daanvinken left a comment

Choose a reason for hiding this comment

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

Awesome!

Comment thread docs/quickstart.md Outdated
@jdheyburn
Copy link
Copy Markdown
Collaborator

@bjosv valkey-io/valkey-helm#162 is merged now, should we update the docs with deploying the operator with Helm (https://github.com/valkey-io/valkey-helm/releases/tag/valkey-operator-0.1.0) or was there anything else to add?

@bjosv
Copy link
Copy Markdown
Collaborator Author

bjosv commented May 5, 2026

@jdheyburn

valkey-io/valkey-helm#162 is merged now, should we update the docs with deploying the operator with Helm

I updated the quickstart guide (for regular users) to use Helm instead, but the developer guide still gives the commands using the makefile. I guess this is how people deploys while developing.

The quickstart guide also propose the use of the valkey-operator container tagged main so it works. By default Helm uses 0.1.0, which does not yet exist, but this text can be updated when 0.1.0 is tagged.

Signed-off-by: Björn Svensson <bjorn.a.svensson@est.tech>
jdheyburn
jdheyburn previously approved these changes May 8, 2026
…r.md‎

Signed-off-by: Björn Svensson <bjorn.a.svensson@est.tech>
@bjosv
Copy link
Copy Markdown
Collaborator Author

bjosv commented May 8, 2026

@jdheyburn I removed two items in the list of current limitations, 1 fixed and 1 soon-to-be-fixed, and linked to the ‎docs/valkeycluster.md‎ as a good reading material as a next step.

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.

[docs] Add quickstart guide for new users

4 participants