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 initial cluster docs #80

Merged
merged 6 commits into from
Aug 28, 2024
Merged

Add initial cluster docs #80

merged 6 commits into from
Aug 28, 2024

Conversation

bjosv
Copy link
Collaborator

@bjosv bjosv commented Aug 27, 2024

This is the cluster overview-docs similar to the existing standalone.md.
Most info taken from the old readme, but reusing the structure from the standalone docs.

Additionally:

  • Update wordlist for spellcheck
  • Enable manual CI-runs of spellcheck.
  • Correcting link in standalone.md.
  • Move gencommands.py to scripts/ (so that the link in docs works..)

Signed-off-by: Björn Svensson <[email protected]>
Signed-off-by: Björn Svensson <[email protected]>
The spellcheck job can be run on own branches before a PR is created.

Signed-off-by: Björn Svensson <[email protected]>
Signed-off-by: Björn Svensson <[email protected]>
Signed-off-by: Björn Svensson <[email protected]>
Copy link
Collaborator

@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.

Great!

I didn't proof-read all of it, but assuming it's mainly hiredis => libvalkey. Or is lots of it rewritten?

Can you delete the corresponding docs in the old README, so we know what's left there to handle later?

docs/cluster.md Outdated Show resolved Hide resolved
docs/cluster.md Outdated Show resolved Hide resolved
@bjosv
Copy link
Collaborator Author

bjosv commented Aug 28, 2024

Can you delete the corresponding docs in the old README, so we know what's left there to handle later?

I will attempt to clean-up/remove the libvalkey and libvalkeycluster directories next, I'll see if there is anything left to add.

@bjosv bjosv merged commit 1ce574c into valkey-io:main Aug 28, 2024
41 checks passed
@bjosv bjosv deleted the add-cluster-docs branch August 28, 2024 07:27
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.

3 participants