[docs] Add quickstart guide and restructure README for v0.1.0#155
[docs] Add quickstart guide and restructure README for v0.1.0#155bjosv wants to merge 10 commits intovalkey-io:mainfrom
Conversation
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>
jdheyburn
left a comment
There was a problem hiding this comment.
This is great thanks! Is there anything blocking it being ready for review? Is it having the helm chart created?
Signed-off-by: Björn Svensson <bjorn.a.svensson@est.tech>
Signed-off-by: Björn Svensson <bjorn.a.svensson@est.tech>
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. |
Signed-off-by: Björn Svensson <bjorn.a.svensson@est.tech>
Signed-off-by: Björn Svensson <bjorn.a.svensson@est.tech>
|
@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? |
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 |
Signed-off-by: Björn Svensson <bjorn.a.svensson@est.tech>
…r.md Signed-off-by: Björn Svensson <bjorn.a.svensson@est.tech>
|
@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. |
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:
pre-commit run --all-filesor hooks on commit)