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

[Blog] Use long options in examples #3

Open
ElijahLynn opened this issue Jun 7, 2016 · 5 comments
Open

[Blog] Use long options in examples #3

ElijahLynn opened this issue Jun 7, 2016 · 5 comments

Comments

@ElijahLynn
Copy link

Thanks for this write up, I am enjoying going through it!

Since this is a post that is intended to teach may I suggest you use long options instead of short options. This would also save some explaining on what the short options are. It is self documenting to use long options (most of the time).

e.g.

docker run --name db -e MYSQL_ROOT_PASSWORD=123 -p 3306:3306 mysql:latest  
docker run --name db --env=[MYSQL_ROOT_PASSWORD=123] --publish=3306:3306 mysql:latest  

Also, step #3 for the command above discusses the --detach command but it isn't in the example.

@dwmkerr
Copy link
Owner

dwmkerr commented Jun 7, 2016

I've fixed step #3, for now I've left the short examples but documented the long form below them. This is because it's much more common to see the short values, WDYT?

@ElijahLynn
Copy link
Author

That is a happy balance, thanks.

@ElijahLynn
Copy link
Author

I know it would be a lot of work but adding clarification throughout what the long options are would make it a better teaching tool, not just the one example above.

e.g. docker run -it ubuntu, if it were docker run --interactive --tty it would make more sense.

@ElijahLynn ElijahLynn reopened this Jun 7, 2016
@ElijahLynn
Copy link
Author

ElijahLynn commented Jun 7, 2016

I am not suggesting to replace that just do what you did in #3 (comment) after the first usage of it and clarify what those options do and/or state the long options.

@dwmkerr
Copy link
Owner

dwmkerr commented Jun 11, 2016

Good idea, will change this when I get a little time!

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

No branches or pull requests

2 participants