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
Organize etcdctl commands and add more documents #17777
Comments
I want to get more involve in etcd community and i think with this issue i can help to make |
/area documentation |
I can't think of any reason we wouldn't want to do this. I'd suggest opening PRs; the task sounds massive, though, so maybe we should follow a targeted approach to individual subcommands to open it up to discussion. @jmhbnz, any thoughts on this? |
Hey @ah8ad3 - Thanks for raising this. I am absolutely on board with improving the built in documentation. I do actually like seeing all the available subcommands at once rather than gating them behind additional If you can see gaps for documentation please feel free to start raising some pull requests, thanks! /assign @ah8ad3 |
My perspective is these tasks:
add description and some sample usages/result in these files
Just in case as an example the document of
I expect |
What would you like to be added?
I want commands of etcdctl to be organized and documented in a better way.
We can do something like this:
And rest of this for other commands.
For example when we invoke
etcdctl leahe -h
we getMaybe we can do something like this:
Add a one line description so new users can understand what it is without going and searching for what is the lease, it's a tradeoff we don't want to throw the whole document here just a little sip of what is it.
And put some popular usages in the USAGE section would be nice too.
Why is this needed?
As a newcomer to etcdctl it was hard for me to understand what it does at first, i was constantly searching the websites for commands to understand some of it. To enhance user experience, I propose implementing measures to clarify command functionalities upfront, easing the learning curve.
Also i think the first view of
etcdctl -h
is a little bit crowded and i believe with removing some subcommands that are not necessarry to show at first and style it a little bit this way users are greeted with a more intuitive interface.The text was updated successfully, but these errors were encountered: