From e06da3489747cdc50c747e796c3c4f65708998fe Mon Sep 17 00:00:00 2001 From: Hrishikesh Kadam Date: Tue, 31 Aug 2021 23:55:28 +0530 Subject: [PATCH 01/10] Update Getting Started Part 4 Mentioning sharing images in step 1 is ambiguous. --- get-started/04_sharing_app.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/get-started/04_sharing_app.md b/get-started/04_sharing_app.md index 1b35797539..5c6d9a9b79 100644 --- a/get-started/04_sharing_app.md +++ b/get-started/04_sharing_app.md @@ -17,9 +17,7 @@ registry. The default registry is Docker Hub and is where all of the images we'v To push an image, we first need to create a repository on Docker Hub. -1. [Sign up](https://www.docker.com/pricing?utm_source=docker&utm_medium=webreferral&utm_campaign=docs_driven_upgrade){:target="_blank" rel="noopener" class="_"} and share images using Docker Hub. - -2. Sign in to [Docker Hub](https://hub.docker.com){:target="_blank" rel="noopener" class="_"}. +1. [Sign up](https://www.docker.com/pricing?utm_source=docker&utm_medium=webreferral&utm_campaign=docs_driven_upgrade){:target="_blank" rel="noopener" class="_"} or Sign in to [Docker Hub](https://hub.docker.com){:target="_blank" rel="noopener" class="_"}. 2. Click the **Create Repository** button. From e212290b317c24f8d183b35b19f0b219f047fcb8 Mon Sep 17 00:00:00 2001 From: Hrishikesh Kadam Date: Sat, 4 Sep 2021 18:52:01 +0530 Subject: [PATCH 02/10] Correct language identifier code block --- get-started/07_multi_container.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/get-started/07_multi_container.md b/get-started/07_multi_container.md index 3fc9929c4f..b255026550 100644 --- a/get-started/07_multi_container.md +++ b/get-started/07_multi_container.md @@ -56,7 +56,7 @@ For now, we will create the network first and attach the MySQL container at star If you are using PowerShell then use this command. - ```console + ```powershell PS> docker run -d ` --network todo-app --network-alias mysql ` -v todo-mysql-data:/var/lib/mysql ` @@ -194,7 +194,7 @@ With all of that explained, let's start our dev-ready container! If you are using PowerShell then use this command. - ```console + ```powershell PS> docker run -dp 3000:3000 ` -w /app -v "$(pwd):/app" ` --network todo-app ` From c33a56e2f7cf46d4d4a7fc4e367d1c0392da683a Mon Sep 17 00:00:00 2001 From: Hrishikesh Kadam Date: Sun, 5 Sep 2021 22:05:25 +0530 Subject: [PATCH 03/10] Minor changes to ci-cd/github-actions.md --- ci-cd/github-actions.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ci-cd/github-actions.md b/ci-cd/github-actions.md index f2b7677f33..f4ea924fab 100644 --- a/ci-cd/github-actions.md +++ b/ci-cd/github-actions.md @@ -183,7 +183,7 @@ on: ``` {% endraw %} -This ensures that the main CI will only trigger if we tag our commits with `V.n.n.n.` Let’s test this. For example, run the following command: +This ensures that the main CI will only trigger if we tag our commits with something like `v1.0.2` Let’s test this. For example, run the following command: ```console $ git tag -a v1.0.2 @@ -228,7 +228,7 @@ Remember to change how the image is tagged. The following example keeps ‘lates ![Update tagged images](images/ghcr-logic.png){:width="500px"} -Now, we will have two different flows: one for our changes to master, and one for our pull requests. Next, we need to modify what we had before to ensure we are pushing our PRs to the GitHub registry rather than to Docker Hub. +Now, we will have two different flows: one for our changes to master, and one for our pushed tags. Next, we need to modify what we had before to ensure we are pushing our PRs to the GitHub registry rather than to Docker Hub. ## Conclusion From 9dd353952bb78ee1977e1a926e7e4a0b48763769 Mon Sep 17 00:00:00 2001 From: Masahiro Aoki Date: Thu, 9 Sep 2021 13:54:54 +0900 Subject: [PATCH 04/10] Update run-containers.md --- language/nodejs/run-containers.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/language/nodejs/run-containers.md b/language/nodejs/run-containers.md index 64ad1fe8ca..d4bf853907 100644 --- a/language/nodejs/run-containers.md +++ b/language/nodejs/run-containers.md @@ -32,9 +32,7 @@ Let’s open a new terminal then make a GET request to the server using the curl $ curl --request POST \ --url http://localhost:8000/test \ --header 'content-type: application/json' \ - --data '{ - "msg": "testing" -}' + --data '{"msg": "testing"}' curl: (7) Failed to connect to localhost port 8000: Connection refused ``` From a9a8311643622a802932b752e49f285efa878c80 Mon Sep 17 00:00:00 2001 From: Wajdi Al-Hawari Date: Sat, 11 Sep 2021 01:17:05 -0400 Subject: [PATCH 05/10] Improves how requirements.txt is created - To reduce the error prone process of grabbing all Python packages in the global Python scope, the specific package is extracted and set in to the requirements.txt file --- language/python/build-images.md | 2 +- language/python/develop.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/language/python/build-images.md b/language/python/build-images.md index f2012a2a66..81fe7e2241 100644 --- a/language/python/build-images.md +++ b/language/python/build-images.md @@ -29,7 +29,7 @@ Let’s create a simple Python application using the Flask framework that we’l ```console $ cd /path/to/python-docker $ pip3 install Flask -$ pip3 freeze > requirements.txt +$ pip3 freeze | grep Flask >> requirements.txt $ touch app.py ``` diff --git a/language/python/develop.md b/language/python/develop.md index 45e3a0bd96..19b466f30e 100644 --- a/language/python/develop.md +++ b/language/python/develop.md @@ -147,7 +147,7 @@ First, let’s add the `mysql-connector-python` module to our application using ```console $ pip3 install mysql-connector-python -$ pip3 freeze > requirements.txt +$ pip3 freeze | grep mysql-connector-python >> requirements.txt ``` Now we can build our image. From eaa4a41c5df9b112d9e5b4327f3f51e5eebae710 Mon Sep 17 00:00:00 2001 From: Shyamal Jadav Date: Mon, 20 Sep 2021 14:49:58 +0530 Subject: [PATCH 06/10] Update kube-deploy.md --- get-started/kube-deploy.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/get-started/kube-deploy.md b/get-started/kube-deploy.md index ed61088537..71703ac4d2 100644 --- a/get-started/kube-deploy.md +++ b/get-started/kube-deploy.md @@ -95,8 +95,8 @@ All containers in Kubernetes are scheduled as _pods_, which are groups of co-loc if all is well, your deployment should be listed as follows: ```shell - NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE - bb-demo 1 1 1 1 48s + NAME READY UP-TO-DATE AVAILABLE AGE + bb-demo 1/1 1 1 40s ``` This indicates all one of the pods you asked for in your YAML are up and running. Do the same check for your services: From 1720aae2a2a535f3473440efc3211c72bb8beb76 Mon Sep 17 00:00:00 2001 From: Peter Dave Hello Date: Sat, 2 Oct 2021 15:39:32 +0800 Subject: [PATCH 07/10] Simplify Debian & Ubuntu Docker Engine installation guide --- engine/install/debian.md | 31 +----------------------------- engine/install/ubuntu.md | 41 +--------------------------------------- 2 files changed, 2 insertions(+), 70 deletions(-) diff --git a/engine/install/debian.md b/engine/install/debian.md index 06e3ecaf2a..dd16ccc3d9 100644 --- a/engine/install/debian.md +++ b/engine/install/debian.md @@ -107,41 +107,12 @@ from the repository. > `BunsenLabs Linux Helium`, you could use `stretch`. Docker does not offer any guarantees on untested > and unsupported Debian distributions. - -
-
- ```console $ echo \ - "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] {{ download-url-base }} \ + "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] {{ download-url-base }} \ $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null ``` -
-
- - ```console - $ echo \ - "deb [arch=armhf signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] {{ download-url-base }} \ - $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null - ``` - -
-
- - ```console - $ echo \ - "deb [arch=arm64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] {{ download-url-base }} \ - $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null - ``` - -
-
- #### Install Docker Engine This procedure works for Debian on `x86_64` / `amd64`, `armhf`, `arm64`, and Raspbian. diff --git a/engine/install/ubuntu.md b/engine/install/ubuntu.md index 1d33c5eb90..eb08334052 100644 --- a/engine/install/ubuntu.md +++ b/engine/install/ubuntu.md @@ -124,51 +124,12 @@ from the repository. > `Linux Mint Tessa`, you could use `bionic`. Docker does not offer any guarantees on untested > and unsupported Ubuntu distributions. - -
-
- ```console $ echo \ - "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] {{ download-url-base }} \ + "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] {{ download-url-base }} \ $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null ``` -
-
- - ```console - $ echo \ - "deb [arch=armhf signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] {{ download-url-base }} \ - $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null - ``` - -
-
- - ```console - $ echo \ - "deb [arch=arm64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] {{ download-url-base }} \ - $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null - ``` - -
-
- - ```console - $ echo \ - "deb [arch=s390x signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] {{ download-url-base }} \ - $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null - ``` - -
-
- #### Install Docker Engine 1. Update the `apt` package index, and install the _latest version_ of Docker From 84e15774263f716d76965df280b57351a9aa54ec Mon Sep 17 00:00:00 2001 From: Mathieu Champlon Date: Mon, 4 Oct 2021 06:41:02 +0200 Subject: [PATCH 08/10] Fix version invocation for v2 --- compose/cli-command.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/compose/cli-command.md b/compose/cli-command.md index 95704b7172..87c03338b6 100644 --- a/compose/cli-command.md +++ b/compose/cli-command.md @@ -93,7 +93,7 @@ from the [project release page](https://github.com/docker/compose/releases){:tar 3. Test your installation ```console - $ docker compose --version + $ docker compose version Docker Compose version 2.0.0 ``` From c1a35e1ba020447d2c78c1d27e1b439a54bfb15c Mon Sep 17 00:00:00 2001 From: Typing Turtle Date: Mon, 4 Oct 2021 05:50:21 -0400 Subject: [PATCH 09/10] Minor `read-only` clarification (#13521) * Minor `read-only` clarification ## Why It was not obvious to me that `ro` is the shorthand form of `readonly`. ## Description This adds a bit of text to explicitly state that `ro` is the shorthand form of `readonly` when using volumes * Update storage/volumes.md Co-authored-by: Sebastiaan van Stijn Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com> Co-authored-by: Sebastiaan van Stijn --- storage/volumes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/storage/volumes.md b/storage/volumes.md index b8c2f7763c..163b9e5079 100644 --- a/storage/volumes.md +++ b/storage/volumes.md @@ -72,7 +72,7 @@ If you need to specify volume driver options, you must use `--mount`. is mounted in the container. May be specified as `destination`, `dst`, or `target`. - The `readonly` option, if present, causes the bind mount to be [mounted into - the container as read-only](#use-a-read-only-volume). + the container as read-only](#use-a-read-only-volume). May be specified as `readonly` or `ro`. - The `volume-opt` option, which can be specified more than once, takes a key-value pair consisting of the option name and its value. From a0e59a68b080a5edde0bcf3e2e4c8ffd8ec9b752 Mon Sep 17 00:00:00 2001 From: rolyli Date: Mon, 4 Oct 2021 10:51:23 +0100 Subject: [PATCH 10/10] Update style inconsistencies for code prompts in get-started (#13580) * Fix style inconsistencies for powershell code in get-started * Fix style inconsistencies for powershell code in get-started --- get-started/06_bind_mounts.md | 2 +- get-started/08_using_compose.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/get-started/06_bind_mounts.md b/get-started/06_bind_mounts.md index 79ea87ddcd..741f2ea978 100644 --- a/get-started/06_bind_mounts.md +++ b/get-started/06_bind_mounts.md @@ -52,7 +52,7 @@ So, let's do it! If you are using PowerShell then use this command: ```powershell - docker run -dp 3000:3000 ` + PS> docker run -dp 3000:3000 ` -w /app -v "$(pwd):/app" ` node:12-alpine ` sh -c "yarn install && yarn run dev" diff --git a/get-started/08_using_compose.md b/get-started/08_using_compose.md index 62af7e919f..048aeb9ae1 100644 --- a/get-started/08_using_compose.md +++ b/get-started/08_using_compose.md @@ -65,10 +65,10 @@ $ docker run -dp 3000:3000 \ sh -c "yarn install && yarn run dev" ``` -If you are using PowerShell then use this command. +If you are using PowerShell then use this command: ```powershell -docker run -dp 3000:3000 ` +PS> docker run -dp 3000:3000 ` -w /app -v "$(pwd):/app" ` --network todo-app ` -e MYSQL_HOST=mysql ` @@ -171,10 +171,10 @@ $ docker run -d \ mysql:5.7 ``` -If you are using PowerShell then use this command. +If you are using PowerShell then use this command: ```powershell -docker run -d ` +PS> docker run -d ` --network todo-app --network-alias mysql ` -v todo-mysql-data:/var/lib/mysql ` -e MYSQL_ROOT_PASSWORD=secret `