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

init docker examples #86

Closed
wants to merge 1 commit into from

Conversation

louis-riviere-xyz
Copy link
Contributor

No description provided.

@srsudar
Copy link
Owner

srsudar commented Jun 10, 2020

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
Copy link
Contributor Author

louis-riviere-xyz commented Jun 10, 2020 via email

@srsudar
Copy link
Owner

srsudar commented Jun 22, 2020

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
Copy link
Contributor Author

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
Copy link
Contributor Author

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
Copy link
Owner

srsudar commented Nov 15, 2021

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

@srsudar srsudar closed this Nov 15, 2021
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

Successfully merging this pull request may close these issues.

2 participants