From af2683ffd41d3559b4507fe3680f631061cff4ec Mon Sep 17 00:00:00 2001 From: CrazyMax Date: Mon, 22 Aug 2022 13:48:30 +0200 Subject: [PATCH 01/12] ci: switch stage2 to stage environment Signed-off-by: CrazyMax --- .github/workflows/deploy.yml | 4 ++-- .github/workflows/publish.yml | 9 +-------- 2 files changed, 3 insertions(+), 10 deletions(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 59c263c2f0..83476a9021 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -23,13 +23,13 @@ jobs: JEKYLL_ENV=development DOCS_AWS_REGION=us-east-1 if [ "${{ github.ref }}" = "refs/heads/master" ]; then - DOCS_URL="https://docs-stage2.docker.com" # TODO: change this to https://docs-stage.docker.com when new env switched and ready + DOCS_URL="https://docs-stage.docker.com" DOCS_AWS_IAM_ROLE="arn:aws:iam::710015040892:role/stage-docs-docs.docker.com-20220818202135984800000001" DOCS_S3_BUCKET="stage-docs-docs.docker.com" DOCS_S3_CONFIG="s3-config.json" DOCS_CLOUDFRONT_ID="E1R7CSW3F0X4H8" DOCS_LAMBDA_FUNCTION_REDIRECTS="DockerDocsRedirectFunction-stage" - DOCS_SLACK_MSG="Successfully deployed docs-stage2 from master branch. $DOCS_URL" # TODO: change to "deployed docs-stage" when new env switched and ready + DOCS_SLACK_MSG="Successfully deployed docs-stage from master branch. $DOCS_URL" elif [ "${{ github.ref }}" = "refs/heads/published" ]; then #JEKYLL_ENV=production # TODO: uncomment when new env switched and ready DOCS_URL="https://docs2.docker.com" # TODO: change this to https://docs.docker.com when new env switched and ready diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index d249323ccf..0a6eb08d52 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -4,7 +4,6 @@ on: workflow_dispatch: push: branches: - - master - published jobs: @@ -16,13 +15,7 @@ jobs: run: | JEKYLL_ENV=development DOCS_AWS_REGION=us-east-1 - if [ "${{ github.ref }}" = "refs/heads/master" ]; then - DOCS_URL="https://docs-stage.docker.com" - DOCS_S3_BUCKET="docs.docker.com-stage-us-east-1" - DOCS_S3_CONFIG="_website-config-docs-stage.json" - DOCS_LAMBDA_FUNCTION_CACHE="arn:aws:lambda:us-east-1:710015040892:function:docs-stage-cache-invalidator" - DOCS_SLACK_MSG="Successfully promoted docs-stage from master. https://docs-stage.docker.com/" - elif [ "${{ github.ref }}" = "refs/heads/published" ]; then + if [ "${{ github.ref }}" = "refs/heads/published" ]; then JEKYLL_ENV=production DOCS_URL="https://docs.docker.com" DOCS_S3_BUCKET="docs.docker.com-us-east-1" From 3883cac81719610e478808dcba2d579893dcdf70 Mon Sep 17 00:00:00 2001 From: Jerae Duffin Date: Wed, 24 Aug 2022 13:31:10 -0500 Subject: [PATCH 02/12] updated link in overview --- _includes/registry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_includes/registry.md b/_includes/registry.md index 3a3229a1e0..39f28e5de5 100644 --- a/_includes/registry.md +++ b/_includes/registry.md @@ -2,7 +2,7 @@ > > This page contains information about hosting your own registry using the -> open source Docker Registry. For information about Docker Hub, which offers a +> [open source Docker Registry](https://github.com/distribution/distribution){: target="_blank" rel="noopener" class="_"}. For information about Docker Hub, which offers a > hosted registry with additional features such as teams, organizations, web > hooks, automated builds, etc, see [Docker Hub](/docker-hub/). {: .important } From 27686c1f483b9dd1f9d7c3e2e8f2d79570eefe93 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Fri, 26 Aug 2022 17:17:27 +0200 Subject: [PATCH 03/12] desktop: add missing redirects for dashboard The dashboard topic was rolled up into the "get-started" section in commit ab0dee78a2835162b0c69af567cf00276e46da09, which removed links from the TOC. The page itself was removed in 13ee3ff42626a64dddf8e2a119bbbd77505738c5, but forgot to add/copy the redirects. This patch adds the redirects back, and fixes some links to the page that's now missing. Signed-off-by: Sebastiaan van Stijn --- _includes/landing-page/volume-management.html | 2 +- _layouts/landing.html | 2 +- desktop/index.md | 8 +++++--- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/_includes/landing-page/volume-management.html b/_includes/landing-page/volume-management.html index c4bdb7c5bc..29f779f12a 100644 --- a/_includes/landing-page/volume-management.html +++ b/_includes/landing-page/volume-management.html @@ -10,7 +10,7 @@
- + Learn more
diff --git a/_layouts/landing.html b/_layouts/landing.html index 12671d7520..1204acd882 100644 --- a/_layouts/landing.html +++ b/_layouts/landing.html @@ -233,7 +233,7 @@
Popular articles

Docker Desktop WSL 2 backend

Install Docker Desktop on Mac

-

Docker Desktop Dashboard

+

Docker Desktop Dashboard

Deploy on Kubernetes

Release notes

Logs and troubleshooting

diff --git a/desktop/index.md b/desktop/index.md index f597943f4a..8e23d5e6ee 100644 --- a/desktop/index.md +++ b/desktop/index.md @@ -3,10 +3,12 @@ description: Docker Desktop overview keywords: Desktop, Docker, GUI, run, docker, local, machine, dashboard title: Docker Desktop redirect_from: -- /desktop/opensource/ -- /docker-for-mac/opensource/ -- /docker-for-windows/opensource/ - /desktop/dashboard/ +- /desktop/opensource/ +- /docker-for-mac/dashboard/ +- /docker-for-mac/opensource/ +- /docker-for-windows/dashboard/ +- /docker-for-windows/opensource/ --- > **Update to the Docker Desktop terms** From 2ab284be75fd64edc3e8d82183589b3f85317b39 Mon Sep 17 00:00:00 2001 From: Ulysses Souza Date: Fri, 19 Aug 2022 02:07:52 +0200 Subject: [PATCH 04/12] Review/Refactor of precedence table Rebase --- compose/envvars-precedence.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/compose/envvars-precedence.md b/compose/envvars-precedence.md index 08efd41ea7..8fd05bbb96 100644 --- a/compose/envvars-precedence.md +++ b/compose/envvars-precedence.md @@ -5,15 +5,15 @@ keywords: compose, environment, env file --- ## Order of precedence -1. Passed from the command-line [`docker compose run --env `](../../engine/reference/commandline/compose_run/#options). -2. Passed from/set in `compose.yaml` service's configuration, [from the environment key](../../compose/compose-file/#environment). -3. Passed from/set in `compose.yaml` service's configuration, [from the env_file key](../../compose/compose-file/#env_file). -4. Passed from/set in Container Image [in ENV directive](../../engine/reference/builder/#env). +1. Passed from the command-line [`docker compose run --env `](../../engine/reference/commandline/compose_run/#options). +2. Passed from/set in `compose.yaml` service's configuration, from the [environment key](../../compose/compose-file/#environment). +3. Passed from/set in `compose.yaml` service's configuration, from the [env_file key](../../compose/compose-file/#env_file). +4. Passed from/set in Container Image in [ENV directive](../../engine/reference/builder/#env). ### Precedence quick overview table The table below provides a quick overview of how interpolation works when using all environment variables on Compose, using `TAG`, an environmental variable defining the version for an image, as an example. -Each row represents a scenario and each columns represents a context where you can be setting or passing an environment variable. +Each row represents a scenario and each column represents a context where you can be setting or passing an environment variable. | # | `.env` file | `compose.yaml`:`env_file` key | `compose.yaml`:`environment` key | CMD | Image | OS | Resolved as | |:-:|:--------------------------:|:-----------------------------:|:---------------------------------:|:------------:|:-------------:|:------------:|:-----------------:| @@ -35,8 +35,12 @@ Each row represents a scenario and each columns represents a context where you c | 16| Unset | Unset | `TAG=1.7` | Unset | `TAG=1.6` | `TAG=1.4` | `TAG=1.4` | Description for each column: +* `.env` file - `.env` file on the project root (or, with higher precedence, the file passed via `docker compose -–env-file `). +* `OS` environment - OS Environment variable * Image - `ENV` directive in the Dockerfile -* .env file - `.env` file on the project root (or, with higher precedence, the file passed via `docker compose -–env-file `). -* Command line - environmental variable passed via `docker compose run -e `. -* Compose file - in `environment` key from the service section in the `compose.yaml`. -* Compose file - in `env_file key` from the service section in the `compose.yaml`. +* Compose file - In `env_file` key from the service section in the `compose.yaml`. +* Compose file - In `environment` key from the service section in the `compose.yaml`. +* Command line - Environmental variable passed via `docker compose run -e `. +* Resolved as - This column expresses the result available in the container. + +**Note that the "`OS`" has precedence over "`.env` file" column for variable resolution in the other columns.** \ No newline at end of file From 9124e41e82a871d863d308306b53c7394e868b76 Mon Sep 17 00:00:00 2001 From: Ulysses Souza Date: Fri, 19 Aug 2022 02:22:32 +0200 Subject: [PATCH 05/12] Rebase - minor edits --- compose/environment-variables.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/compose/environment-variables.md b/compose/environment-variables.md index e1c61d5b41..949df826e9 100644 --- a/compose/environment-variables.md +++ b/compose/environment-variables.md @@ -33,14 +33,10 @@ You can set default values for any environment variables referenced in the Compose file, or used to configure Compose, in an [environment file](env-file.md) named `.env`. The `.env` file path is as follows: - - Starting with `+v1.28`, `.env` file is placed at the base of the project directory + - Starting with `+v1.28`, `.env` file is placed at the base of the project directory. - Project directory can be explicitly defined with the `--file` option or `COMPOSE_FILE` - environment variable. Otherwise, it is the current working directory where the - `docker compose` command is executed (`+1.28`). - - For previous versions, it might have trouble resolving `.env` file with - `--file` or `COMPOSE_FILE`. To work around it, it is recommended to use `--project-directory`, - which overrides the path for the `.env` file. This inconsistency is addressed - in `+v1.28` by limiting the filepath to the project directory. + environment variable. Otherwise, it is the current working directory where the `docker compose` command is executed (`+1.28`). + - For previous versions, it might have trouble resolving `.env` file with `--file` or `COMPOSE_FILE`. To work around it, it is recommended to use `--project-directory`, which overrides the path for the `.env` file. This inconsistency is addressed in `+v1.28` by limiting the file path to the project directory. ```console @@ -233,7 +229,7 @@ $ docker compose exec api node ``` Having any `ARG` or `ENV` setting in a `Dockerfile` evaluates only if there is -no Docker Compose entry for `environment` or `env_file`. +no Docker Compose entry for `environment`, `env_file` or `run --env`. > Specifics for NodeJS containers > From 95519c425db1e305e7ffc92c2d4f7200383ad975 Mon Sep 17 00:00:00 2001 From: dockertopia Date: Mon, 29 Aug 2022 10:41:43 +0100 Subject: [PATCH 06/12] Minor edit --- compose/envvars-precedence.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/compose/envvars-precedence.md b/compose/envvars-precedence.md index 8fd05bbb96..189019f2f1 100644 --- a/compose/envvars-precedence.md +++ b/compose/envvars-precedence.md @@ -8,7 +8,7 @@ keywords: compose, environment, env file 1. Passed from the command-line [`docker compose run --env `](../../engine/reference/commandline/compose_run/#options). 2. Passed from/set in `compose.yaml` service's configuration, from the [environment key](../../compose/compose-file/#environment). 3. Passed from/set in `compose.yaml` service's configuration, from the [env_file key](../../compose/compose-file/#env_file). -4. Passed from/set in Container Image in [ENV directive](../../engine/reference/builder/#env). +4. Passed from/set in Container Image in the [ENV directive](../../engine/reference/builder/#env). ### Precedence quick overview table The table below provides a quick overview of how interpolation works when using all environment variables on Compose, using `TAG`, an environmental variable defining the version for an image, as an example. From abc10b0cae7a13f57e75e47d3e54326d058b1dbd Mon Sep 17 00:00:00 2001 From: Dockertopia <103652162+dockertopia@users.noreply.github.com> Date: Mon, 29 Aug 2022 12:19:34 +0100 Subject: [PATCH 07/12] Apply suggestions from code review Implementing suggestions. Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- compose/environment-variables.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/compose/environment-variables.md b/compose/environment-variables.md index 949df826e9..0b3af89697 100644 --- a/compose/environment-variables.md +++ b/compose/environment-variables.md @@ -33,10 +33,10 @@ You can set default values for any environment variables referenced in the Compose file, or used to configure Compose, in an [environment file](env-file.md) named `.env`. The `.env` file path is as follows: - - Starting with `+v1.28`, `.env` file is placed at the base of the project directory. + - Starting from `v1.28`, the `.env` file is placed at the base of the project directory. - Project directory can be explicitly defined with the `--file` option or `COMPOSE_FILE` environment variable. Otherwise, it is the current working directory where the `docker compose` command is executed (`+1.28`). - - For previous versions, it might have trouble resolving `.env` file with `--file` or `COMPOSE_FILE`. To work around it, it is recommended to use `--project-directory`, which overrides the path for the `.env` file. This inconsistency is addressed in `+v1.28` by limiting the file path to the project directory. + - For versions older than `v1.28`, it might have trouble resolving `.env` file with `--file` or `COMPOSE_FILE`. To work around it, it is recommended to use `--project-directory`, which overrides the path for the `.env` file. This inconsistency is addressed in `v1.28` by limiting the file path to the project directory. ```console From a1dfa5aa190a9791097182952c992f22beab597e Mon Sep 17 00:00:00 2001 From: Efim <94497805+fimmicon@users.noreply.github.com> Date: Mon, 29 Aug 2022 18:23:23 +0300 Subject: [PATCH 08/12] fix typo --- storage/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/storage/index.md b/storage/index.md index 6103ea1f54..9b143e6d15 100644 --- a/storage/index.md +++ b/storage/index.md @@ -23,7 +23,7 @@ Docker has two options for containers to store files on the host machine, so that the files are persisted even after the container stops: _volumes_, and _bind mounts_. -Docker also supports containers storing files in-memory on the the host machine. Such files are not persisted. +Docker also supports containers storing files in-memory on the host machine. Such files are not persisted. If you're running Docker on Linux, _tmpfs mount_ is used to store files in the host's system memory. If you're running Docker on Windows, _named pipe_ is used to store files in the host's system memory. From 0a66270ce5ccbd28966df51f9cd0b29771a97a69 Mon Sep 17 00:00:00 2001 From: Shy Ruparel Date: Mon, 29 Aug 2022 15:15:42 -0400 Subject: [PATCH 09/12] Corrected spelling. --- .../build/set-up/minimal-frontend-using-docker-cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/desktop/extensions-sdk/build/set-up/minimal-frontend-using-docker-cli.md b/desktop/extensions-sdk/build/set-up/minimal-frontend-using-docker-cli.md index 3557ab0dc0..e1e75bc337 100644 --- a/desktop/extensions-sdk/build/set-up/minimal-frontend-using-docker-cli.md +++ b/desktop/extensions-sdk/build/set-up/minimal-frontend-using-docker-cli.md @@ -25,7 +25,7 @@ Although you can start from an empty directory, it is highly recommended that yo └── client # (3) │ └── src │ ├── App.tsx -│ └── ... React aplication +│ └── ... React application ``` 1. Contains everything required to build the extension and run it in Docker Desktop. From 7b769cbe79c588397f6de8d5fdb8c52ab65210a1 Mon Sep 17 00:00:00 2001 From: Milos Gajdos Date: Tue, 30 Aug 2022 08:46:41 +0100 Subject: [PATCH 10/12] Fix URL paths in deprecated API replacements --- docker-hub/api/deprecated.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docker-hub/api/deprecated.md b/docker-hub/api/deprecated.md index a7105b2530..8c163b258c 100644 --- a/docker-hub/api/deprecated.md +++ b/docker-hub/api/deprecated.md @@ -21,9 +21,9 @@ If you want to continue using the Docker Hub API in your current applications, u | **OLD** | **NEW** | | -------------- | ------------ | -| [/v1/repositories/{name}/images](https://github.com/moby/moby/blob/v1.3.0/docs/sources/reference/api/docker-io_api.md#list-user-repository-images)| [/v2/namespaces/{namespace}/repositories/{repository}/images](https://docs.docker.com/docker-hub/api/latest/#tag/images/operation/GetNamespacesRepositoriesImages)| -| [/v1/repositories/{namespace}/{name}/images](https://github.com/moby/moby/blob/v1.3.0/docs/sources/reference/api/docker-io_api.md#list-user-repository-images)| [/v2/namespaces/{namespace}/repositories/{repository}/images](https://docs.docker.com/docker-hub/api/latest/#tag/images/operation/GetNamespacesRepositoriesImages)| -| [/v1/repositories/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#list-repository-tags)| [/v2/namespace/{namespace}/repositories/{repository}/tags](/docker-hub/api/latest/#tag/repositories/paths/~1v2~1namespace~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags/get) | -| [/v1/repositories/{namespace}/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#list-repository-tags)| [/v2/namespace/{namespace}/repositories/{repository}/tags](/docker-hub/api/latest/#tag/repositories/paths/~1v2~1namespace~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags/get)| +| [/v1/repositories/{name}/images](https://github.com/moby/moby/blob/v1.3.0/docs/sources/reference/api/docker-io_api.md#list-user-repository-images)| [/v2/namespaces/{namespace}/repositories/{repository}/images](https://docs.docker.com/docker-hub/api/latest/#tag/images/operation/GetNamespacesRepositoriesImages)| +| [/v1/repositories/{namespace}/{name}/images](https://github.com/moby/moby/blob/v1.3.0/docs/sources/reference/api/docker-io_api.md#list-user-repository-images)| [/v2/namespaces/{namespace}/repositories/{repository}/images](https://docs.docker.com/docker-hub/api/latest/#tag/images/operation/GetNamespacesRepositoriesImages)| +| [/v1/repositories/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#list-repository-tags)| [/v2/namespaces/{namespace}/repositories/{repository}/tags](/docker-hub/api/latest/#tag/repositories/paths/~1v2~1namespace~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags/get)| +| [/v1/repositories/{namespace}/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#list-repository-tags)| [/v2/namespaces/{namespace}/repositories/{repository}/tags](/docker-hub/api/latest/#tag/repositories/paths/~1v2~1namespace~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags/get)| | [/v1/repositories/{namespace}/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#get-image-id-for-a-particular-tag)| [/v2/namespaces/{namespace}/repositories/{repository}/tags/{tag}](/docker-hub/api/latest/#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags~1%7Btag%7D/get)| | [/v1/repositories/{namespace}/{name}/tags/{tag_name}](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#get-image-id-for-a-particular-tag)| [/v2/namespaces/{namespace}/repositories/{repository}/tags/{tag}](/docker-hub/api/latest/#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags~1%7Btag%7D/get)| From d28ef5e4708ec1c0702c7e17d8de6396a3d5d7cc Mon Sep 17 00:00:00 2001 From: Nick Adcock Date: Tue, 30 Aug 2022 14:10:58 +0100 Subject: [PATCH 11/12] Show hostname in hub API examples (#15524) Signed-off-by: Nick Adcock Signed-off-by: Nick Adcock --- _layouts/hub-api.html | 2 +- docker-hub/api/latest.yaml | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/_layouts/hub-api.html b/_layouts/hub-api.html index 22a7d42a78..ceba834b1a 100644 --- a/_layouts/hub-api.html +++ b/_layouts/hub-api.html @@ -16,7 +16,7 @@ - + diff --git a/docker-hub/api/latest.yaml b/docker-hub/api/latest.yaml index 703e86aa51..4e9f9f599b 100644 --- a/docker-hub/api/latest.yaml +++ b/docker-hub/api/latest.yaml @@ -16,6 +16,7 @@ info: Docker provides an API that allows you to interact with Docker Hub. Browse through the Docker Hub API documentation to explore the supported endpoints. + tags: - name: resources x-displayName: Resources @@ -1275,7 +1276,7 @@ components: type: array items: type: string - example: [ urn:ietf:params:scim:api:messages:2.0:ListResponse ] + example: [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ] totalResults: type: integer example: 1 @@ -1302,7 +1303,7 @@ components: type: array items: type: string - example: [ urn:ietf:params:scim:api:messages:2.0:ListResponse ] + example: [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ] totalResults: type: integer example: 1 @@ -2300,7 +2301,7 @@ components: type: array items: type: string - example: [ urn:ietf:params:scim:schemas:core:2.0:Schema ] + example: [ "urn:ietf:params:scim:schemas:core:2.0:Schema" ] id: type: string example: urn:ietf:params:scim:schemas:core:2.0:User From e5ee3278539a335e1a01c475c5e2032bfef8eb61 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Tue, 30 Aug 2022 15:11:48 +0200 Subject: [PATCH 12/12] added link to distribution/distribution (#15512) --- registry/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/registry/index.md b/registry/index.md index 54148c5add..5e07bb2248 100644 --- a/registry/index.md +++ b/registry/index.md @@ -13,6 +13,8 @@ title: Docker Registry The Registry is a stateless, highly scalable server side application that stores and lets you distribute Docker images. The Registry is open-source, under the permissive [Apache license](https://en.wikipedia.org/wiki/Apache_License). +You can find the source code on +[GitHub](https://github.com/distribution/distribution){: target="blank" rel="noopener" class=""}. ## Why use it