From e34c407516eeed9ade6084048c546068c84cc847 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Sun, 19 Apr 2020 17:23:09 +0200 Subject: [PATCH] docs/reference: explain "colon" Colon may not be something non-native English readers know about, so explain the symbol in the running text. Signed-off-by: Sebastiaan van Stijn --- docs/reference/commandline/build.md | 2 +- docs/reference/commandline/history.md | 3 ++- docs/reference/commandline/images.md | 2 +- docs/reference/commandline/network_ls.md | 2 +- docs/reference/commandline/node_ls.md | 3 ++- docs/reference/commandline/node_ps.md | 2 +- docs/reference/commandline/plugin_ls.md | 2 +- docs/reference/commandline/ps.md | 2 +- docs/reference/commandline/search.md | 2 +- docs/reference/commandline/secret_ls.md | 2 +- docs/reference/commandline/service_create.md | 2 +- docs/reference/commandline/service_ls.md | 2 +- docs/reference/commandline/service_ps.md | 2 +- docs/reference/commandline/stack_ls.md | 2 +- docs/reference/commandline/stack_ps.md | 2 +- docs/reference/commandline/stack_services.md | 2 +- docs/reference/commandline/stats.md | 2 +- docs/reference/commandline/system_df.md | 2 +- docs/reference/commandline/volume_ls.md | 2 +- 19 files changed, 21 insertions(+), 19 deletions(-) diff --git a/docs/reference/commandline/build.md b/docs/reference/commandline/build.md index 153300f281..0167d054f0 100644 --- a/docs/reference/commandline/build.md +++ b/docs/reference/commandline/build.md @@ -84,7 +84,7 @@ user credentials, VPN's, and so forth. > the repository and its submodules using a `git clone --recursive` command. Git URLs accept context configuration in their fragment section, separated by a -colon `:`. The first part represents the reference that Git will check out, +colon (`:`). The first part represents the reference that Git will check out, and can be either a branch, a tag, or a remote reference. The second part represents a subdirectory inside the repository that will be used as a build context. diff --git a/docs/reference/commandline/history.md b/docs/reference/commandline/history.md index 4fa714ef1f..c6cfdd1f7b 100644 --- a/docs/reference/commandline/history.md +++ b/docs/reference/commandline/history.md @@ -68,7 +68,8 @@ output the data exactly as the template declares or, when using the `table` directive, will include column headers as well. The following example uses a template without headers and outputs the -`ID` and `CreatedSince` entries separated by a colon for the `busybox` image: +`ID` and `CreatedSince` entries separated by a colon (`:`) for the `busybox` +image: ```bash $ docker history --format "{{.ID}}: {{.CreatedSince}}" busybox diff --git a/docs/reference/commandline/images.md b/docs/reference/commandline/images.md index 8774b630a9..e64fd32dc1 100644 --- a/docs/reference/commandline/images.md +++ b/docs/reference/commandline/images.md @@ -308,7 +308,7 @@ output the data exactly as the template declares or, when using the `table` directive, will include column headers as well. The following example uses a template without headers and outputs the -`ID` and `Repository` entries separated by a colon for all images: +`ID` and `Repository` entries separated by a colon (`:`) for all images: ```bash $ docker images --format "{{.ID}}: {{.Repository}}" diff --git a/docs/reference/commandline/network_ls.md b/docs/reference/commandline/network_ls.md index 60a0b04f6c..d48673aaba 100644 --- a/docs/reference/commandline/network_ls.md +++ b/docs/reference/commandline/network_ls.md @@ -221,7 +221,7 @@ output the data exactly as the template declares or, when using the `table` directive, includes column headers as well. The following example uses a template without headers and outputs the -`ID` and `Driver` entries separated by a colon for all networks: +`ID` and `Driver` entries separated by a colon (`:`) for all networks: ```bash $ docker network ls --format "{{.ID}}: {{.Driver}}" diff --git a/docs/reference/commandline/node_ls.md b/docs/reference/commandline/node_ls.md index 980755d490..8e4eb703ad 100644 --- a/docs/reference/commandline/node_ls.md +++ b/docs/reference/commandline/node_ls.md @@ -152,7 +152,8 @@ output the data exactly as the template declares or, when using the `table` directive, includes column headers as well. The following example uses a template without headers and outputs the -`ID`, `Hostname`, and `TLS Status` entries separated by a colon for all nodes: +`ID`, `Hostname`, and `TLS Status` entries separated by a colon (`:`) for all +nodes: ```bash $ docker node ls --format "{{.ID}}: {{.Hostname}} {{.TLSStatus}}" diff --git a/docs/reference/commandline/node_ps.md b/docs/reference/commandline/node_ps.md index 0d549d9fe0..c6dcc9f891 100644 --- a/docs/reference/commandline/node_ps.md +++ b/docs/reference/commandline/node_ps.md @@ -130,7 +130,7 @@ output the data exactly as the template declares or, when using the `table` directive, includes column headers as well. The following example uses a template without headers and outputs the -`Name` and `Image` entries separated by a colon for all tasks: +`Name` and `Image` entries separated by a colon (`:`) for all tasks: ```bash $ docker node ps --format "{{.Name}}: {{.Image}}" diff --git a/docs/reference/commandline/plugin_ls.md b/docs/reference/commandline/plugin_ls.md index 262357ddc2..3261fec8d9 100644 --- a/docs/reference/commandline/plugin_ls.md +++ b/docs/reference/commandline/plugin_ls.md @@ -88,7 +88,7 @@ output the data exactly as the template declares or, when using the `table` directive, includes column headers as well. The following example uses a template without headers and outputs the -`ID` and `Name` entries separated by a colon for all plugins: +`ID` and `Name` entries separated by a colon (`:`) for all plugins: ```bash $ docker plugin ls --format "{{.ID}}: {{.Name}}" diff --git a/docs/reference/commandline/ps.md b/docs/reference/commandline/ps.md index f824e6c47b..41f701d297 100644 --- a/docs/reference/commandline/ps.md +++ b/docs/reference/commandline/ps.md @@ -421,7 +421,7 @@ exactly as the template declares or, when using the `table` directive, includes column headers as well. The following example uses a template without headers and outputs the `ID` and -`Command` entries separated by a colon for all running containers: +`Command` entries separated by a colon (`:`) for all running containers: ```bash $ docker ps --format "{{.ID}}: {{.Command}}" diff --git a/docs/reference/commandline/search.md b/docs/reference/commandline/search.md index af29ef5f0e..76d6cf7d8a 100644 --- a/docs/reference/commandline/search.md +++ b/docs/reference/commandline/search.md @@ -152,7 +152,7 @@ output the data exactly as the template declares. If you use the `table` directive, column headers are included as well. The following example uses a template without headers and outputs the -`Name` and `StarCount` entries separated by a colon for all images: +`Name` and `StarCount` entries separated by a colon (`:`) for all images: ```bash $ docker search --format "{{.Name}}: {{.StarCount}}" nginx diff --git a/docs/reference/commandline/secret_ls.md b/docs/reference/commandline/secret_ls.md index b574f41f55..8e8b086b9e 100644 --- a/docs/reference/commandline/secret_ls.md +++ b/docs/reference/commandline/secret_ls.md @@ -126,7 +126,7 @@ output the data exactly as the template declares or, when using the `table` directive, will include column headers as well. The following example uses a template without headers and outputs the -`ID` and `Name` entries separated by a colon for all images: +`ID` and `Name` entries separated by a colon (`:`) for all images: ```bash $ docker secret ls --format "{{.ID}}: {{.Name}}" diff --git a/docs/reference/commandline/service_create.md b/docs/reference/commandline/service_create.md index 32276dccf3..4ae820fcc9 100644 --- a/docs/reference/commandline/service_create.md +++ b/docs/reference/commandline/service_create.md @@ -926,7 +926,7 @@ Long form syntax of `--network` allows to specify list of aliases and driver opt You can publish service ports to make them available externally to the swarm using the `--publish` flag. The `--publish` flag can take two different styles of arguments. The short version is positional, and allows you to specify the -published port and target port separated by a colon. +published port and target port separated by a colon (`:`). ```bash $ docker service create --name my_web --replicas 3 --publish 8080:80 nginx diff --git a/docs/reference/commandline/service_ls.md b/docs/reference/commandline/service_ls.md index 7aa5954da9..acb1e2c1f8 100644 --- a/docs/reference/commandline/service_ls.md +++ b/docs/reference/commandline/service_ls.md @@ -141,7 +141,7 @@ output the data exactly as the template declares or, when using the `table` directive, includes column headers as well. The following example uses a template without headers and outputs the -`ID`, `Mode`, and `Replicas` entries separated by a colon for all services: +`ID`, `Mode`, and `Replicas` entries separated by a colon (`:`) for all services: ```bash $ docker service ls --format "{{.ID}}: {{.Mode}} {{.Replicas}}" diff --git a/docs/reference/commandline/service_ps.md b/docs/reference/commandline/service_ps.md index 19f5352b63..66c9a52d3b 100644 --- a/docs/reference/commandline/service_ps.md +++ b/docs/reference/commandline/service_ps.md @@ -171,7 +171,7 @@ output the data exactly as the template declares or, when using the `table` directive, includes column headers as well. The following example uses a template without headers and outputs the -`Name` and `Image` entries separated by a colon for all tasks: +`Name` and `Image` entries separated by a colon (`:`) for all tasks: ```bash $ docker service ps --format "{{.Name}}: {{.Image}}" top diff --git a/docs/reference/commandline/stack_ls.md b/docs/reference/commandline/stack_ls.md index 93a705d710..08815f801e 100644 --- a/docs/reference/commandline/stack_ls.md +++ b/docs/reference/commandline/stack_ls.md @@ -63,7 +63,7 @@ the data exactly as the template declares or, when using the `table` directive, includes column headers as well. The following example uses a template without headers and outputs the -`Name` and `Services` entries separated by a colon for all stacks: +`Name` and `Services` entries separated by a colon (`:`) for all stacks: ```bash $ docker stack ls --format "{{.Name}}: {{.Services}}" diff --git a/docs/reference/commandline/stack_ps.md b/docs/reference/commandline/stack_ps.md index 2c9e4b8ebf..81cadc16a0 100644 --- a/docs/reference/commandline/stack_ps.md +++ b/docs/reference/commandline/stack_ps.md @@ -140,7 +140,7 @@ output the data exactly as the template declares or, when using the `table` directive, includes column headers as well. The following example uses a template without headers and outputs the -`Name` and `Image` entries separated by a colon for all tasks: +`Name` and `Image` entries separated by a colon (`:`) for all tasks: ```bash $ docker stack ps --format "{{.Name}}: {{.Image}}" voting diff --git a/docs/reference/commandline/stack_services.md b/docs/reference/commandline/stack_services.md index 5610f4414e..cbe6966797 100644 --- a/docs/reference/commandline/stack_services.md +++ b/docs/reference/commandline/stack_services.md @@ -101,7 +101,7 @@ output the data exactly as the template declares or, when using the `table` directive, includes column headers as well. The following example uses a template without headers and outputs the -`ID`, `Mode`, and `Replicas` entries separated by a colon for all services: +`ID`, `Mode`, and `Replicas` entries separated by a colon (`:`) for all services: ```bash $ docker stack services --format "{{.ID}}: {{.Mode}} {{.Replicas}}" diff --git a/docs/reference/commandline/stats.md b/docs/reference/commandline/stats.md index 5c69758d30..5b5d3f6a1e 100644 --- a/docs/reference/commandline/stats.md +++ b/docs/reference/commandline/stats.md @@ -149,7 +149,7 @@ outputs the data exactly as the template declares or, when using the `table` directive, includes column headers as well. The following example uses a template without headers and outputs the -`Container` and `CPUPerc` entries separated by a colon for all images: +`Container` and `CPUPerc` entries separated by a colon (`:`) for all images: ```bash $ docker stats --format "{{.Container}}: {{.CPUPerc}}" diff --git a/docs/reference/commandline/system_df.md b/docs/reference/commandline/system_df.md index 8dfaf29e5a..92e070bef0 100644 --- a/docs/reference/commandline/system_df.md +++ b/docs/reference/commandline/system_df.md @@ -99,7 +99,7 @@ the data exactly as the template declares or, when using the `table` directive, will include column headers as well. The following example uses a template without headers and outputs the -`Type` and `TotalCount` entries separated by a colon: +`Type` and `TotalCount` entries separated by a colon (`:`): ```bash $ docker system df --format "{{.Type}}: {{.TotalCount}}" diff --git a/docs/reference/commandline/volume_ls.md b/docs/reference/commandline/volume_ls.md index f7463572dc..c697ead133 100644 --- a/docs/reference/commandline/volume_ls.md +++ b/docs/reference/commandline/volume_ls.md @@ -171,7 +171,7 @@ output the data exactly as the template declares or, when using the `table` directive, includes column headers as well. The following example uses a template without headers and outputs the -`Name` and `Driver` entries separated by a colon for all volumes: +`Name` and `Driver` entries separated by a colon (`:`) for all volumes: ```bash $ docker volume ls --format "{{.Name}}: {{.Driver}}"