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

Conversation

Projects
None yet
4 participants
@mistyhacks
Copy link
Contributor

mistyhacks 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.

Add features to CLI ref template
- 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
@thaJeztah

This comment has been minimized.

Copy link
Member

thaJeztah commented Jan 13, 2018

❤️ gonna give this a spin tomorrow

@thaJeztah
Copy link
Member

thaJeztah left a comment

LGTM 👍

@mistyhacks mistyhacks merged commit f688179 into docker:master Jan 16, 2018

2 checks passed

continuous-integration/jenkins/pr-head This commit looks good
Details
deploy/netlify Deploy preview ready!
Details

@mistyhacks mistyhacks deleted the mistyhacks:improve-cli-template-experimental branch Jan 16, 2018

@pospanet

This comment has been minimized.

Copy link

pospanet commented Apr 26, 2018

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

@gbarr01

This comment has been minimized.

Copy link
Contributor

gbarr01 commented Apr 26, 2018

@pospanet

This comment has been minimized.

Copy link

pospanet commented Apr 26, 2018

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

@mistyhacks

This comment has been minimized.

Copy link
Contributor Author

mistyhacks commented Apr 26, 2018

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

This comment has been minimized.

Copy link

pospanet commented Apr 26, 2018

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

This comment has been minimized.

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

This comment has been minimized.

Copy link

pospanet commented Apr 27, 2018

@gbarr01 It works !!! :-) Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.