diff --git a/_data/toc.yaml b/_data/toc.yaml index fe0f94a0ba0..39b18959b01 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -927,8 +927,6 @@ reference: title: docker checkpoint - path: /edge/engine/reference/commandline/checkpoint_create/ title: docker checkpoint create - - path: /edge/engine/reference/commandline/checkpoint_create/ - title: docker checkpoint create - path: /edge/engine/reference/commandline/checkpoint_ls/ title: docker checkpoint ls - path: /edge/engine/reference/commandline/checkpoint_rm/ diff --git a/_includes/cli.md b/_includes/cli.md index 729529989c4..042d7b5c468 100644 --- a/_includes/cli.md +++ b/_includes/cli.md @@ -12,9 +12,9 @@ {% if site.data[include.datafolder][include.datafile].min_api_version %} -API {{ site.data[include.datafolder][include.datafile].min_api_version }}+  +API {{ site.data[include.datafolder][include.datafile].min_api_version }}+  The client and daemon API must both be at least -{{ site.data[include.datafolder][include.datafile].min_api_version }} +{{ site.data[include.datafolder][include.datafile].min_api_version }} to use this command. Use the `docker version` command on the client to check your client and daemon API versions. @@ -22,7 +22,7 @@ your client and daemon API versions. {% if site.data[include.datafolder][include.datafile].deprecated %} -> This command is deprecated. +> This command is [deprecated](/engine/deprecated.md){: target="_blank" class="_"}. > > It may be removed in a future Docker version. {: .warning } @@ -34,6 +34,9 @@ your client and daemon API versions. > This command is experimental. > > This command is experimental on the Docker daemon. It should not be used in production environments. +> To enable experimental features on the Docker daemon, edit the +> [daemon.json](/engine/reference/commandline/dockerd.md#daemon-configuration-file) +> and set `experimental` to `true`. {: .important } {% endif %} @@ -43,6 +46,9 @@ your client and daemon API versions. > This command is experimental. > > This command is experimental on the Docker client. It should not be used in production environments. +> To enable experimental features in the Docker CLI, edit the +> [config.json](/engine/reference/commandline/cli.md#configuration-files) +> and set `experimental` to `enabled`. {: .important } {% endif %} @@ -50,12 +56,12 @@ your client and daemon API versions. {% capture command-orchestrator %} {% if site.data[include.datafolder][include.datafile].swarm %} -Swarm This command works with the Swarm orchestrator. +Swarm This command works with the Swarm orchestrator. {% endif %} {% if site.data[include.datafolder][include.datafile].kubernetes %} -Kubernetes This command works with the Kubernetes orchestrator. +Kubernetes This command works with the Kubernetes orchestrator. {% endif %} {% endcapture %}{{ command-orchestrator }} @@ -89,16 +95,20 @@ your client and daemon API versions. {% for option in alloptions %} - {% capture min-api %}{% if option.min_api_version %}API {{ option.min_api_version }}+ {% endif %}{%endcapture%} - {% capture stability-string %}{% if option.deprecated and (option.experimental or option.experimentalcli) %}deprecated experimental {% elsif option.deprecated %}deprecated {% elsif (option.experimental or option.experimentalcli) %}experimental {% endif %}{% endcapture %} - {% capture flag-orchestrator %}{% if option.swarm %}Swarm{% endif %}{% if option.kubernetes %}Kubernetes{% endif %}{% endcapture %} - {% capture all-badges %}{% unless min-api == '' and stability-string == '' %}{{ min-api }}{{ stability-string }}{{ flag-orchestrator }}
{% endunless %}{% endcapture %} + {% capture deprecated-badge %}{% if option.deprecated %}deprecated{% endif %}{% endcapture %} + {% capture experimental-daemon-badge %}{% if option.experimental %}experimental (daemon){% endif %}{% endcapture %} + {% capture experimental-cli-badge %}{% if option.experimentalcli %}experimental (CLI){% endif %}{% endcapture %} + {% capture min-api %}{% if option.min_api_version %}API {{ option.min_api_version }}+{% endif %}{%endcapture%} + {% capture flag-orchestrator %}{% if option.swarm %}Swarm{% endif %}{% if option.kubernetes %}Kubernetes{% endif %}{% endcapture %} + + {% capture all-badges %}{{ deprecated-badge }}{{ experimental-daemon-badge }}{{ experimental-cli-badge }}{{ min-api }}{{ flag-orchestrator }}{% endcapture %} + {% assign defaults-to-skip = "[],map[],false,0,0s,default,'',\"\"" | split: ',' %} {% capture option-default %}{% if option.default_value %}{% unless defaults-to-skip contains option.default_value or defaults-to-skip == blank %}`{{ option.default_value }}`{% endunless %}{% endif %}{% endcapture %} `--{{ option.option }}{% if option.shorthand %} , -{{ option.shorthand }}{% endif %}` {{ option-default }} - {{ all-badges | strip }}{{ option.description | strip }} + {% if all-badges != '' %}{{ all-badges | strip }}
{% endif %}{{ option.description | strip }} {% endfor %} diff --git a/test.md b/test.md index 2ab35854a72..22d0eb0bc36 100644 --- a/test.md +++ b/test.md @@ -533,6 +533,47 @@ You can have badges. You can also have yellow badges or red badges. +#### Badges as links + +You can make a badge a link. Wrap the `` with an `` (not the other way +around) so that the text on the badge is still white. + +```html +Test +``` + +Test + + +You can also put tooltips on badges (as the example above shows). Keep reading for tooltips. + +### Tooltips + +To add a tooltip to any element, set `data-toggle="tooltip"` and set a `title`. +Hovering over the element with the mouse pointer will make it visible. Tooltips +are not visible on mobile devices or touchscreens, so don't rely on them as the +only way to communicate important info. + +```html +Test +``` + +Test + +You can optionally set the `data-placement` attribute to `top`, `bottom`, +`middle`, `center`, `left`, or `right`. Only set it if not setting it causes +layout issues. + +You don't have to use HTML. You can also set these attributes using Markdown. + +```markdown +This is a paragraph that has a tooltip. We position it to the left so it doesn't align with the middle top of the paragraph (that looks weird). +{:data-toggle="tooltip" data-placement="left" title="Markdown tooltip example"} +``` + +This is a paragraph that has a tooltip. We position it to the left so it doesn't align with the middle top of the paragraph (that looks weird). +{:data-toggle="tooltip" data-placement="left" title="Markdown tooltip example"} + ## Running in-page Javascript If you need to run custom Javascript within a page, and it depends upon JQuery