init docker examples

[srsudar]

This would be a popular one I think. I think we should include some additional basic examples though. I'm not a docker expert, but there are a few that I've used before. I might look through the tutorial and add some of the more common ones.

[louis-riviere-xyz]

I don't think eg should repeat man pages, so I don't include the "basic ones". Docker is well documented and the "basic ones" are easy to find and might be useless/redundant in eg. I think that eg should contains less obvious "recipes" that are not easy to figure out, not in the manual. By the way, that also holds for other commands.

Le 2020-06-10 17:11, Sam Sudar a écrit :

This would be a popular one I think. I think we should include some additional basic examples though. I'm not a docker expert, but there are a few that I've used before. I might look through the tutorial and add some of the more common ones.

-- You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub [1], or unsubscribe [2].

Links:

[1] https://github.com/srsudar/eg/pull/86#issuecomment-642074246 [2] https://github.com/notifications/unsubscribe-auth/AFO3UTBI6NDDJ4H3IBWFAELRV6PCNANCNFSM4N2DTOFA

[srsudar]

That is a good point, and one that I go back and forth on. One of the troubles I have with man pages is that the syntax is frequently hard to parse at a glance, at least for me. In many cases I think it's quicker to pull up the eg page than to look at the man page.

By the way, that also holds for other commands.

When you say that do you have any examples in mind where the current content doesn't do what you think it should?

[louis-riviere-xyz]

I think it's quicker to pull up the eg page than to look at the man page.

I think so too, that's why I like eg, and that's why we shouldn't clutter it up with useless entries.

• cd
• change do target-directory
• cd target-directory
• Basic Usage
• Change your current working directory to the target directory:
• $ cd

Not only it's useless (nobody will look for that in eg), but it's repeated twice ... I think eg would be better without this kind of enries.

For Docker, there would be no benefit in adding:

docker ps list containers

[louis-riviere-xyz]

maybe it would be nice to split eg pages in sections, the eg page for eg could be something like:

Show all examples for a command: eg \<command>

Show only basic usage: eg -b \<command>

Show advanced section only: eg -a \<command>

[srsudar]

Sorry for letting this languish. This would be a useful one but needs more examples I think.