Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
Proposal: Group available commands in the command line help text into "general", "image centric" and "container centric" #8756
Newbie here, who had a hard time "getting" how to work with docker, until I realized there are 2-3 categories of commands available to the docker command: General commands, image centric ones, and container centric ones (and I had to look up the difference between the last two as well).
Currently, all the commands are mixed together in a long and thus comparably unreadable list:
I think, grouping them into the categories methined above ("general", "image centric" and "container centric") would go a very long way in making this list less confusing, and to highlight the difference between images and containers, from the start, to help new users note the difference.
So, what about grouping them something like this (Not sure I've classified the commands 100% correctly, so correct me on that):
(I also added
@fredlf no maybe about it - thats what I was indicating - not everyone does it the same way.
I'm a little worried that this kind of grouping hasn't worked well for me in other tools - for eg,
Alpha-order is also a terrible match for all task oriented grouping....
Sorry, what an awesfully round about way of saying +0.98
It occurs to me that there's no reason we can't have both alphabetical and grouped. I'd think you'd want the grouped list first, for the less experienced users who will visit the page the most, with the alpha-list below. Back-to-top links would be a nice touch too. Thoughts, @SvenDowideit @jamtur01 @samuell ?
I think the basic problem is that the list is just becoming too long and for some commands it is unclear what they apply to. I can relate to both "points of view". @fredlf I think you're talking about the website, not the CLI help?
Couple of additional issues I see;
"Export/Import" and "Save/Load"
I've seen some issues reported on the issue tracker, because it was unclear that, for example,
Perhaps change the wording a bit (happy to provide a separate PR);
I think that most, if not all, options (except for
Making daemon a command in stead is beyond scope (see #6055), but the daemon flags could be put in a separate group:
I think we should separate the discussion of the cli help output (which this PR and #8594) are about from rearranging the online help.
I presonally prefer
If I were you, I'd make a PR :)
I think there at least 5 distinct concerns:
On Sat, 10 Sep 2016, 02:05 Arnaud Porterie, firstname.lastname@example.org