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 the supporting status of subcommands in the website #2587

Open
1 of 2 tasks
PragmaTwice opened this issue Oct 8, 2024 · 4 comments
Open
1 of 2 tasks

Add the supporting status of subcommands in the website #2587

PragmaTwice opened this issue Oct 8, 2024 · 4 comments
Labels
enhancement type enhancement good first issue Good for newcomers help wanted Good for newcomers

Comments

@PragmaTwice
Copy link
Member

PragmaTwice commented Oct 8, 2024

Search before asking

  • I had searched in the issues and found no similar issues.

Motivation

https://kvrocks.apache.org/docs/supported-commands

In this page users can check if a command is supported or not.

For CLUSTER and CLUSTERX we have a list to state the supporting status of every subcommands of these command,
but for many other commands we don't, e.g. CLIENT, SCRIPT...

We need to add subcommand supporting list for every command that have subcommands.

Solution

For source code of the website, refer to https://github.com/apache/kvrocks-website.

Are you willing to submit a PR?

  • I'm willing to submit a PR!
@PragmaTwice PragmaTwice added enhancement type enhancement help wanted Good for newcomers good first issue Good for newcomers labels Oct 8, 2024
@beingPro007
Copy link

@PragmaTwice i would be happy if you assign this to me!!!

@beingPro007
Copy link

@PragmaTwice
Could you clarify which specific commands currently lack subcommand listings?

I've noticed that commands like CLUSTER and CLUSTERX have detailed subcommand lists, but other commands such as CLIENT and SCRIPT don't. To improve the consistency of the documentation, it would be helpful to know which commands require subcommand listings to be added. Could you provide a list of such commands so we can address this gap?

@PragmaTwice
Copy link
Member Author

@PragmaTwice Could you clarify which specific commands currently lack subcommand listings?

I've noticed that commands like CLUSTER and CLUSTERX have detailed subcommand lists, but other commands such as CLIENT and SCRIPT don't. To improve the consistency of the documentation, it would be helpful to know which commands require subcommand listings to be added. Could you provide a list of such commands so we can address this gap?

Hi, thank you for your interest and question.

You can check Redis documentation to know if a command has subcommands. All commands that have subcommands need to be listed.

BTW I recommend to be familiar with Redis before taking this task. Then you can easily identify what kind of commands are likely to have subcommands.

@beingPro007
Copy link

@PragmaTwice Could you clarify which specific commands currently lack subcommand listings?

I've noticed that commands like CLUSTER and CLUSTERX have detailed subcommand lists, but other commands such as CLIENT and SCRIPT don't. To improve the consistency of the documentation, it would be helpful to know which commands require subcommand listings to be added. Could you provide a list of such commands so we can address this gap?

Hi, thank you for your interest and question.

You can check Redis documentation to know if a command has subcommands. All commands that have subcommands need to be listed.

BTW I recommend to be familiar with Redis before taking this task. Then you can easily identify what kind of commands are likely to have subcommands.

Ok let me first be familiar with redis. Thank you for your consideration

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement type enhancement good first issue Good for newcomers help wanted Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants