diff --git a/_includes/cli.md b/_includes/cli.md index db75bdc9e7..f28ce4247f 100644 --- a/_includes/cli.md +++ b/_includes/cli.md @@ -1,7 +1,6 @@ {% capture tabChar %} {% endcapture %} -{% if include.datafolder and include.datafile %} - {% assign controller_data = site.data[include.datafolder][include.datafile] %} +{% assign parentPath = page.path | prepend: "/" | remove: page.name %} ## Description @@ -19,7 +18,7 @@ your client and daemon API versions. {% if controller_data.deprecated %} -> This command is [deprecated](/engine/deprecated.md){: target="_blank" class="_"}. +> This command is [deprecated](/engine/deprecated/){: target="_blank" class="_"}. > > It may be removed in a future Docker version. {: .warning } @@ -42,7 +41,7 @@ your client and daemon API versions. > 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) +> [daemon.json](/engine/reference/commandline/dockerd/#daemon-configuration-file) > and set `experimental` to `true`. > > {% include experimental.md %} @@ -56,7 +55,7 @@ your client and daemon API versions. > **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) +> [config.json](/engine/reference/commandline/cli/#configuration-files) > and set `experimental` to `enabled`. You can go [here](https://docs.docker.com/engine/reference/commandline/cli/#experimental-features) > for more information. {: .important } @@ -81,8 +80,8 @@ your client and daemon API versions. ## Usage -```none -{{ controller_data.usage | replace: tabChar,"" | strip }}{% if controller_data.cname %} COMMAND{% endif %} +```console +{{ controller_data.usage | replace: tabChar, "" | strip }}{% if controller_data.cname %} COMMAND{% endif %} ``` {% endif %} @@ -116,15 +115,12 @@ For example uses of this command, refer to the [examples section](#examples) bel {% for option in alloptions %} - - {% 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 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 %} @@ -132,11 +128,9 @@ For example uses of this command, refer to the [examples section](#examples) bel {{ option-default }} {% if all-badges != '' %}{{ all-badges | strip }}
{% endif %}{{ option.description | strip }} - {% endfor %} - {% endif %} {% if controller_data.examples %} @@ -145,11 +139,6 @@ For example uses of this command, refer to the [examples section](#examples) bel {{ controller_data.examples }} -{% endif %} -{% else %} - -The include.datafolder or include.datafile was not set. - {% endif %} {% if controller_data.pname %} @@ -157,13 +146,13 @@ The include.datafolder or include.datafile was not set. ## Parent command -{% capture parentfile %}{{ controller_data.plink | replace: ".yaml", "" | replace: "docker_","" }}{% endcapture %} -{% capture parentdatafile %}{{ controller_data.plink | replace: ".yaml", "" }}{% endcapture %} +{% capture parentfile %}{{ controller_data.plink | remove_first: ".yaml" | remove_first: "docker_" }}{% endcapture %} +{% capture parentdatafile %}{{ controller_data.plink | remove_first: ".yaml" }}{% endcapture %} {% capture parentDesc %}{{ site.data[include.datafolder][parentdatafile].short }}{% endcapture %} | Command | Description | | ------- | ----------- | -| [{{ controller_data.pname }}]({{ parentfile }}) | {{ parentDesc }}| +| [{{ controller_data.pname }}]({{parentPath}}{{ parentfile }}/) | {{ parentDesc }}| {% endunless %} {% endif %} @@ -181,9 +170,9 @@ The include.datafolder or include.datafile was not set. {% for command in controller_data.cname %} - {% capture dataFileName %}{{ command | strip | replace: " ","_" }}{% endcapture %} + {% capture dataFileName %}{{ command | strip | replace: " ", "_" }}{% endcapture %} - [{{ command }}]({{ dataFileName | replace: "docker_","" }}/) + [{{ command }}]({{ parentPath }}{{ dataFileName | remove_first: "docker_" }}/) {{ site.data[include.datafolder][dataFileName].short }} {% endfor %} @@ -204,9 +193,9 @@ The include.datafolder or include.datafile was not set. {% for command in site.data[include.datafolder][parentdatafile].cname %} - {% capture dataFileName %}{{ command | strip | replace: " ","_" }}{% endcapture %} + {% capture dataFileName %}{{ command | strip | replace: " ", "_" }}{% endcapture %} - [{{ command }}]({{ dataFileName | replace: "docker_","" }}/) + [{{ command }}]({{ parentPath }}{{ dataFileName | remove_first: "docker_" }}/) {{ site.data[include.datafolder][dataFileName].short }} {% endfor %} @@ -214,3 +203,58 @@ The include.datafolder or include.datafile was not set. {% endunless %} + + diff --git a/_includes/content/compose-var-sub.md b/_includes/content/compose-var-sub.md index c4606251d3..e41d17dd57 100644 --- a/_includes/content/compose-var-sub.md +++ b/_includes/content/compose-var-sub.md @@ -18,7 +18,7 @@ string. In the example above, if `POSTGRES_VERSION` is not set, the value for the `image` option is `postgres:`. You can set default values for environment variables using a -[`.env` file](../env-file.md), which Compose automatically looks for. Values +[`.env` file](/compose/env-file/), which Compose automatically looks for. Values set in the shell environment override those set in the `.env` file. > Note when using docker stack deploy @@ -28,7 +28,7 @@ set in the shell environment override those set in the `.env` file. {: .important } Both `$VARIABLE` and `${VARIABLE}` syntax are supported. Additionally when using -the [2.1 file format](compose-versioning.md#version-21), it is possible to +the [2.1 file format](/compose/compose-file/compose-versioning/#version-21), it is possible to provide inline default values using typical shell syntax: - `${VARIABLE:-default}` evaluates to `default` if `VARIABLE` is unset or diff --git a/_includes/content/ssh/ssh-overview.md b/_includes/content/ssh/ssh-overview.md index 6dfa2940f5..1358081b2c 100644 --- a/_includes/content/ssh/ssh-overview.md +++ b/_includes/content/ssh/ssh-overview.md @@ -1,4 +1,4 @@ -[SSH](/glossary.md#SSH) is a secure protocol for accessing remote machines and applications. It +[SSH](/glossary/#SSH) is a secure protocol for accessing remote machines and applications. It provides authentication and encrypts data communication over insecure networks. These topics describe how to find existing SSH keys or generate new ones, and diff --git a/_includes/docker_ee.md b/_includes/docker_ee.md index 04d97a0daa..04a32e2979 100644 --- a/_includes/docker_ee.md +++ b/_includes/docker_ee.md @@ -3,7 +3,7 @@ | Capabilities | Docker Engine - Enterprise | Docker Enterprise | |:---------------------------------------------------------------------|:-------------------------:|:----------------------------:| | Container engine and built in orchestration, networking, security | {{green-check}} | {{green-check}} | -| [Certified infrastructure, plugins and ISV containers](../ee/supported-platforms/#docker-enterprise) | {{green-check}} | {{green-check}} | -| [Image management with Docker Trusted Registry security scanning](../ee/dtr/user/manage-images/scan-images-for-vulnerabilities/) | | {{green-check}} | -| [Container app management with Universal Control Plane](../ee/ucp/) | | {{green-check}} | -| [Developer solutions with Docker Desktop Enterprise](../ee/desktop/) | | {{green-check}} | +| [Certified infrastructure, plugins and ISV containers](/ee/supported-platforms/#docker-enterprise) | {{green-check}} | {{green-check}} | +| [Image management with Docker Trusted Registry security scanning](/ee/dtr/user/manage-images/scan-images-for-vulnerabilities/) | | {{green-check}} | +| [Container app management with Universal Control Plane](/ee/ucp/) | | {{green-check}} | +| [Developer solutions with Docker Desktop Enterprise](/desktop/enterprise/) | | {{green-check}} | diff --git a/_includes/ee-linux-install-reuse.md b/_includes/ee-linux-install-reuse.md index 20224c7ff3..675534f8c9 100644 --- a/_includes/ee-linux-install-reuse.md +++ b/_includes/ee-linux-install-reuse.md @@ -23,7 +23,7 @@ on {{ linux-dist-long }}: Docker Engine - Community is _not_ supported on {{ linux-dist-long }}. {% endif %} {% if linux-dist == "centos" %} -For Docker Community Edition on {{ linux-dist-cap }}, see [Get Docker Engine - Community for CentOS](/engine/install/centos.md). +For Docker Community Edition on {{ linux-dist-cap }}, see [Get Docker Engine - Community for CentOS](/engine/install/centos/). {% endif %} {% elsif section == "find-ee-repo-url" %} @@ -280,7 +280,7 @@ You only need to set up the repository once, after which you can install Docker ``` Docker Engine - Enterprise is installed and running. Use `sudo` to run Docker commands. See - [Linux postinstall](/engine/install/linux-postinstall.md){: target="_blank" class="_" } to allow + [Linux postinstall](/engine/install/linux-postinstall/){: target="_blank" class="_" } to allow non-privileged users to run Docker commands. @@ -351,7 +351,7 @@ To manually install Docker Enterprise, download the `.{{ package-format | downca ``` Docker Engine - Enterprise is installed and running. Use `sudo` to run Docker commands. See - [Linux postinstall](/engine/install/linux-postinstall.md){: target="_blank" class="_" } to allow + [Linux postinstall](/engine/install/linux-postinstall/){: target="_blank" class="_" } to allow non-privileged users to run Docker commands. @@ -394,7 +394,7 @@ To manually install Docker Enterprise, download the `.{{ package-format | downca ``` Docker Engine - Enterprise is installed and running. Use `sudo` to run Docker commands. See - [Linux postinstall](/engine/install/linux-postinstall.md){: target="_blank" class="_" } to allow + [Linux postinstall](/engine/install/linux-postinstall/){: target="_blank" class="_" } to allow non-privileged users to run Docker commands. @@ -444,7 +444,7 @@ To manually install Docker Enterprise, download the `.{{ package-format | downca ``` Docker Engine - Enterprise is installed and running. Use `sudo` to run Docker commands. See - [Linux postinstall](/engine/install/linux-postinstall.md){: target="_blank" class="_" } to allow + [Linux postinstall](/engine/install/linux-postinstall/){: target="_blank" class="_" } to allow non-privileged users to run Docker commands. {% endif %} @@ -485,7 +485,7 @@ You must delete any edited configuration files manually. {% elsif section == "linux-install-nextsteps" %} -- Continue to [Post-installation steps for Linux](/engine/install/linux-postinstall.md){: target="_blank" class="_" } +- Continue to [Post-installation steps for Linux](/engine/install/linux-postinstall/){: target="_blank" class="_" } - Continue with user guides on [Universal Control Plane (UCP)](/ee/ucp/){: target="_blank" class="_" } and [Docker Trusted Registry (DTR)](/ee/dtr/){: target="_blank" class="_" } diff --git a/_includes/install-script.md b/_includes/install-script.md index 645b86e26a..9185444725 100644 --- a/_includes/install-script.md +++ b/_includes/install-script.md @@ -69,7 +69,7 @@ run Docker commands by default. > **Note**: > > To install Docker without root privileges, see -> [Run the Docker daemon as a non-root user (Rootless mode)](/engine/security/rootless.md). +> [Run the Docker daemon as a non-root user (Rootless mode)](/engine/security/rootless/). > > Rootless mode is currently available as an experimental feature. diff --git a/_includes/kubernetes-mac-win.md b/_includes/kubernetes-mac-win.md index 4390e20fca..3469dcdc8b 100644 --- a/_includes/kubernetes-mac-win.md +++ b/_includes/kubernetes-mac-win.md @@ -55,7 +55,7 @@ your workloads, in parallel, on Kubernetes, Swarm, and as standalone containers. Enabling or disabling the Kubernetes server does not affect your other workloads. -See [{{ product }} > Getting started](/docker-for-{{ platform }}/index.md#kubernetes) to +See [{{ product }} > Getting started](/docker-for-{{ platform }}/#kubernetes) to enable Kubernetes and begin testing the deployment of your workloads on Kubernetes. diff --git a/_layouts/docs.html b/_layouts/docs.html index 797f267cfb..3209e6950c 100755 --- a/_layouts/docs.html +++ b/_layouts/docs.html @@ -1,333 +1,282 @@ - -{% if page.path contains "index.md" %} - {% capture basehref %}{{ page.url }}{% endcapture %} -{% else %} - {% assign crumbs = page.url | split: '/' %} - {% assign stoppingpoint = crumbs | size | minus: 1 %} - {% for crumb in crumbs %} - {% if forloop.index == stoppingpoint %} - {% capture basehref %}{{basehref}}{{ crumb }}/{% endcapture %} - {% break %} - {% else %} - {% capture basehref %}{{basehref}}{{ crumb }}/{% endcapture %} - {% endif %} - {% endfor %} -{% endif %} - - + - - +--> - - - - - - - - {% if site.GH_ENV == "gh_pages" %} - {% endif %} - - - - - - - - - - - - - - - - - - + ng\:form { + display: block; + } + + + + + {% if site.GH_ENV == "gh_pages" %} + {% endif %} + + + + + + + + + + + + + + + + + + - - - - - - + + + + + + - - - - {{ page.title }} | Docker Documentation - - - - - - - - - - {% if page.hide_from_sitemap %}{% endif %} - + + + + {{ page.title }} | Docker Documentation + + + + + + + + + + {% if page.hide_from_sitemap %}{% endif %} + -
- {% if page.landing == true %}{% include global-header.html %}{% endif %} {% if page.landing != true %}{% include header.html %}{% endif %} -
+
+ {% if page.landing == true %} + {% include global-header.html %} + {% else %} + {% include header.html %} + {% endif %} +
+
+
+
+
+
+
+ {% if page.url == '/' %} +

{{ site.name }}

+ {% else %} + {% if page.title %} +

{{ page.title }}

{% endif %} {% if page.advisory %} +
{{ site.data.advisories.texts[page.advisory] | markdownify }}
{% endif %}{% endif %} {% unless page.tree == false or page.skip_read_time == true %}{% include read_time.html %}{% endunless %} + {% if page.enterprise %}{% include ee_dropdown.html %}{% endif %} + {% if page.ui_tabs or page.cli_tabs or page.api_tabs %} + {% capture content %} -
-
-
-
-
-
- {% if page.url == '/' %} -

{{ site.name }}

- {% else %} - {% if page.title %} -

{{ page.title }}

{% endif %} {% if page.advisory %} -
{{ site.data.advisories.texts[page.advisory] | markdownify }}
{% endif %}{% endif %} {% unless page.tree == false or page.skip_read_time == true %}{% include read_time.html %}{% endunless %} - {% if page.enterprise %}{% include ee_dropdown.html %}{% endif %} - {% if page.ui_tabs or page.cli_tabs or page.api_tabs %}{% capture content %} + {% if page.intro %}{{ page.intro | markdownify }}{% else %}{{ page.description | markdownify }}{% endif %} - {% if page.intro %}{{ page.intro | markdownify }}{% else %}{{ page.description | markdownify }}{% endif %} + {% if page.ui_tabs %} + +
{% for tab in page.ui_tabs %} +
{% capture thistab %}{% include_relative {{ page.path | split: "/" | last }} version=tab.version ui="true" %}{% endcapture %}{{ thistab | split: "---" | shift:2 | join: "---" | markdownify }}
{% endfor %} +
+ {% endif %} + {% if page.cli_tabs %} + +
{% for tab in page.cli_tabs %} +
{% capture thistab %}{% include_relative {{ page.path | split: "/" | last }} version=tab.version cli="true" %}{% endcapture %}{{ thistab | split: "---" | shift:2 | join: "---" | markdownify }}
{% endfor %} +
+ {% endif %} + {% if page.api_tabs %} + +
{% for tab in page.api_tabs %} +
{% capture thistab %}{% include_relative {{ page.path | split: "/" | last }} version=tab.version api="true" %}{% endcapture %}{{ thistab | split: "---" | shift:2 | join: "---" | markdownify }}
{% endfor %} +
+ {% endif %} + {% if page.next_steps %} +

Next steps

+ + {% endif %} + {% endcapture %} + {% endif %} + {{ content }} + + {% unless page.notags == true %} + {% assign keywords = page.keywords | split:"," -%} + {% if keywords.size > 0 -%} + + {%- for keyword in keywords -%} + {%- assign strippedKeyword = keyword | strip -%} + {{ strippedKeyword }} + {%- unless forloop.last %}, {% endunless -%} + {% endfor -%} + + {% endif -%} + {% endunless %} + {% if page.noratings != true %} + + {% endif %} +
+
+ +
+ +
+
+
+
+
- {% if page.ui_tabs %} - - -
{% for tab in page.ui_tabs %} -
{% capture thistab %}{% include_relative {{ page.path | split: "/" | last }} version=tab.version ui="true" %}{% endcapture %}{{ thistab | split: "---" | shift:2 | join: "---" | markdownify }}
{% endfor %} -
- - {% endif %} - {% if page.cli_tabs %} - - -
{% for tab in page.cli_tabs %} -
{% capture thistab %}{% include_relative {{ page.path | split: "/" | last }} version=tab.version cli="true" %}{% endcapture %}{{ thistab | split: "---" | shift:2 | join: "---" | markdownify }}
{% endfor %} -
- - {% endif %} - {% if page.api_tabs %} - - -
{% for tab in page.api_tabs %} -
{% capture thistab %}{% include_relative {{ page.path | split: "/" | last }} version=tab.version api="true" %}{% endcapture %}{{ thistab | split: "---" | shift:2 | join: "---" | markdownify }}
{% endfor %} -
- - {% endif %} - - {% if page.next_steps %} - -

Next steps

- - - {% endif %} - {% endcapture %} - {% endif %} - {{ content }} - - {% unless page.notags == true %} - {% assign keywords = page.keywords | split:"," -%} - {% if keywords.size > 0 -%} - - {%- for keyword in keywords -%} - {%- assign strippedKeyword = keyword | strip -%} - {{ strippedKeyword }} - {%- unless forloop.last %}, {% endunless -%} - {% endfor -%} - - {% endif -%} - {% endunless %} - - - {% if page.noratings != true %} - - {% endif %} -
-
- -
- -
-
-
-
-
- - {% if page.path == "404.md" %} - - {% endif %} - - - {% if page.highlightjs == true %} - - - {% endif %} - - - - - - - - - - - - - + {% if page.path == "404.md" %} + + {% endif %} + + + {% if page.highlightjs == true %} + + + {% endif %} + + + + + + + + + + + + + - diff --git a/js/anchorlinks.js b/js/anchorlinks.js index 878ef64001..9a7655848a 100644 --- a/js/anchorlinks.js +++ b/js/anchorlinks.js @@ -5,7 +5,7 @@ for (var i = 0; i < hs.length; i++) { h = hs[i]; if (h.id != null && h.id.length > 0) { - h.insertAdjacentHTML('beforeend', '🔗') + h.insertAdjacentHTML('beforeend', '🔗') } }