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

Add features to CLI ref template #5736

Merged
merged 2 commits into from
Jan 16, 2018
Merged

Add features to CLI ref template #5736

merged 2 commits into from
Jan 16, 2018

Conversation

mdlinville
Copy link

@mdlinville mdlinville commented Jan 13, 2018

  • Differentiate CLI experimental from daemon experimental
  • When the whole command is experimental, point to docs for
    how to get it to show up
  • Make badges links where possible
  • Add tooltips to badges for more context
  • Document in the test.md how to make badges into links and how to use tooltips (shows up at /test/)

Fixes #5718 (except that the CLI ref needs to be rewritten, but that is out of scope for this PR).

You can test some of this on Netlify but if you want to verify that the badge links actually work, you need to build locally with docker build so you get the upstream resources pulled in.

Turning the badges into links is a bit of an Easter egg. They do have tooltips but the point is that they are informative even if people don't realize they can click them. As such, when you do click them it opens the target in a new window / tab.

cc/ @thaJeztah who asked for some of these specifically.

- Differentiate CLI experimental from daemon experimental
- When the whole command is experimental, point to docs for
  how to get it to show up
- Make badges links where possible
- Add tooltips to badges for more context
- Document in the test.md how to make badges into links and how to use tooltips
@mdlinville mdlinville added the area/ux Issue affects functionality of docs.docker.com label Jan 13, 2018
@thaJeztah
Copy link
Member

❤️ gonna give this a spin tomorrow

Copy link
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@mdlinville mdlinville merged commit f688179 into docker:master Jan 16, 2018
@mdlinville mdlinville deleted the improve-cli-template-experimental branch January 16, 2018 20:02
@pospanet
Copy link

Hi. Is there a way how to enable CLI experimental features on docker for windows, please? I am using latest edge version. Thanks

@gbarr01
Copy link
Contributor

gbarr01 commented Apr 26, 2018

@pospanet
Copy link

Hi @gbarr01. Not really. :-( This enable only daemon (server) experimental features, not CLI's

@mdlinville
Copy link
Author

If you look at a reference doc like https://docs.docker.com/edge/engine/reference/commandline/stack_deploy/#options

Notice on flags like --namespace how there is an orange button that says "experimental (CLI)"? You can click that button to get to the doc you need: https://docs.docker.com/engine/reference/commandline/cli/#configuration-files

@pospanet
Copy link

Hi @MistyHacks. Thanks for pointing out. Yet, I have been there with no success. Maybe I am fatally overlooking something, but I did not find any property related to experimental features there.

Which property I have to create/modify in a config.json file, please? Thanks

@gbarr01
Copy link
Contributor

gbarr01 commented Apr 27, 2018

@pospanet , add "experimental": "enabled" to your file, .docker/config.json. Don't forget to add a comma to the entry above it, like this:

{
  "HttpHeaders": {
    "User-Agent": "Docker-Client/18.04.0-ce (linux)"
  },

  "experimental": "enabled"
}

@pospanet
Copy link

@gbarr01 It works !!! :-) Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/ux Issue affects functionality of docs.docker.com
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants