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

Lots of inconsistencies with regards to the name KeyDB <=> Redis #4

Open
hbina opened this issue Oct 2, 2020 · 2 comments
Open

Lots of inconsistencies with regards to the name KeyDB <=> Redis #4

hbina opened this issue Oct 2, 2020 · 2 comments

Comments

@hbina
Copy link
Contributor

hbina commented Oct 2, 2020

I am trying to follow the documentation but noticed that there are a lot of inconsistencies with the name.
I think this is true in many places but I would like to focus on one in particular, https://docs.keydb.dev/docs/first-test/.

  1. There are no such files: ./utils/KeyDB_init_script but there are ./utils/redis_init_script.
  2. There are no such file: ./redis.conf but there are ./keydb.conf.
  3. More importantly, the scripts themselves have mixed name. In the documentation, I am told to change KeyDBPort but there are no such variables, but there are REDISPORT.

I am probably going to find more.
I want to submit a PR but I don't know how big a change/what is the desired name to be.
I suspect this happened because the Redis documentation was simply find+replace'ed to KeyDB.
AFAIK, this project aims to have feature parity with Redis but with different internal implementation.
If that is the case, wouldn't it be better to simply have Redis docs + some appendix?

@hbina hbina changed the title Lots of inconsistencies with regards to KeyDB <=> Redis Lots of inconsistencies with regards to the name KeyDB <=> Redis Oct 2, 2020
@JohnSully
Copy link
Collaborator

@hbina for the cases you reference the best fix is to rename the script in KeyDB

@JohnSully
Copy link
Collaborator

Actually this is really a twopart fix due to the inconsistent capitalization. The script in question should be ./utils/keydb_init_script and obviously the docs should have correct capitalization.

Some of these scripts get used by tests, and so the relevant TCL files need to be updated to call the correct script as well.

A bit more involved than a typo fix but if you are open to working on it I'd love the contribution!

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

No branches or pull requests

2 participants