diff --git a/BUILDING.md b/BUILDING.md index abccd5ebdcd..8066be4f1d4 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -2,10 +2,10 @@ ### Prerequisites * Windows: - * [Docker Desktop](https://hub.docker.com/editions/community/docker-ce-desktop-windows) + * [Docker Desktop](https://docs.docker.com/desktop/setup/install/windows-install/) * make * macOS: - * [Docker Desktop](https://hub.docker.com/editions/community/docker-ce-desktop-mac) + * [Docker Desktop](https://docs.docker.com/desktop/setup/install/mac-install/) * make * Linux: * [Docker 20.10 or later](https://docs.docker.com/engine/install/) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5fef5bd42a7..9b80b8abc45 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ Want to hack on Docker? Awesome! We have a contributor's guide that explains [setting up a Docker development environment and the contribution -process](https://docs.docker.com/contribute/overview/). +process](https://docs.docker.com/contribute/). This page contains information about reporting issues as well as some tips and guidelines useful to experienced open source contributors. Finally, make sure @@ -95,7 +95,7 @@ don't get discouraged! Community Slack - The Docker Community has a dedicated Slack chat to discuss features and issues. You can sign-up with this link. + The Docker Community has a dedicated Slack chat to discuss features and issues. You can sign-up with this link. @@ -118,7 +118,7 @@ don't get discouraged! Stack Overflow Stack Overflow has over 17000 Docker questions listed. We regularly - monitor Docker questions + monitor Docker questions and so do many other knowledgeable Docker users. @@ -200,7 +200,7 @@ For more details, see the [MAINTAINERS](MAINTAINERS) page. The sign-off is a simple line at the end of the explanation for the patch. Your signature certifies that you wrote the patch or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify -the below (from [developercertificate.org](http://developercertificate.org/)): +the below (from [developercertificate.org](https://developercertificate.org/)): ``` Developer Certificate of Origin @@ -252,7 +252,7 @@ commit automatically with `git commit -s`. ### How can I become a maintainer? The procedures for adding new maintainers are explained in the global -[MAINTAINERS](https://github.com/docker/opensource/blob/master/MAINTAINERS) +[MAINTAINERS](https://github.com/docker/opensource/blob/main/MAINTAINERS) file in the [https://github.com/docker/opensource/](https://github.com/docker/opensource/) repository. @@ -311,8 +311,8 @@ The rules: 2. All code should pass the default levels of [`golint`](https://github.com/golang/lint). 3. All code should follow the guidelines covered in [Effective - Go](http://golang.org/doc/effective_go.html) and [Go Code Review - Comments](https://github.com/golang/go/wiki/CodeReviewComments). + Go](https://go.dev/doc/effective_go) and [Go Code Review + Comments](https://go.dev/wiki/CodeReviewComments). 4. Include code comments. Tell us the why, the history and the context. 5. Document _all_ declarations and methods, even private ones. Declare expectations, caveats and anything else that may be important. If a type @@ -334,6 +334,6 @@ The rules: guidelines. Since you've read all the rules, you now know that. If you are having trouble getting into the mood of idiomatic Go, we recommend -reading through [Effective Go](https://golang.org/doc/effective_go.html). The -[Go Blog](https://blog.golang.org) is also a great resource. Drinking the +reading through [Effective Go](https://go.dev/doc/effective_go). The +[Go Blog](https://go.dev/blog/) is also a great resource. Drinking the kool-aid is a lot easier than going thirsty. diff --git a/README.md b/README.md index e017324fbb9..3dfc0de109e 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ - [Legacy](#legacy) # Docker Compose v2 -[![GitHub release](https://img.shields.io/github/release/docker/compose.svg?style=flat-square)](https://github.com/docker/compose/releases/latest) +[![GitHub release](https://img.shields.io/github/v/release/docker/compose.svg?style=flat-square)](https://github.com/docker/compose/releases/latest) [![PkgGoDev](https://img.shields.io/badge/go.dev-docs-007d9c?style=flat-square&logo=go&logoColor=white)](https://pkg.go.dev/github.com/docker/compose/v2) [![Build Status](https://img.shields.io/github/actions/workflow/status/docker/compose/ci.yml?label=ci&logo=github&style=flat-square)](https://github.com/docker/compose/actions?query=workflow%3Aci) [![Go Report Card](https://goreportcard.com/badge/github.com/docker/compose/v2?style=flat-square)](https://goreportcard.com/report/github.com/docker/compose/v2) @@ -28,7 +28,7 @@ single command: `docker compose up`. ### Windows and macOS Docker Compose is included in -[Docker Desktop](https://www.docker.com/products/docker-desktop) +[Docker Desktop](https://www.docker.com/products/docker-desktop/) for Windows and macOS. ### Linux diff --git a/cmd/compose/stats.go b/cmd/compose/stats.go index 2e503fe5db2..98d5aa63af8 100644 --- a/cmd/compose/stats.go +++ b/cmd/compose/stats.go @@ -56,7 +56,7 @@ func statsCommand(p *ProjectOptions, dockerCli command.Cli) *cobra.Command { 'table TEMPLATE': Print output in table format using the given Go template 'json': Print in JSON format 'TEMPLATE': Print output using the given Go template. -Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates`) +Refer to https://docs.docker.com/engine/cli/formatting/ for more information about formatting output with templates`) flags.BoolVar(&opts.noStream, "no-stream", false, "Disable streaming stats and only pull the first result") flags.BoolVar(&opts.noTrunc, "no-trunc", false, "Do not truncate output") return cmd diff --git a/docs/reference/compose_build.md b/docs/reference/compose_build.md index eb05121a7dc..53150cdd868 100644 --- a/docs/reference/compose_build.md +++ b/docs/reference/compose_build.md @@ -4,9 +4,9 @@ Services are built once and then tagged, by default as `project-service`. If the Compose file specifies an -[image](https://github.com/compose-spec/compose-spec/blob/master/spec.md#image) name, +[image](https://github.com/compose-spec/compose-spec/blob/main/spec.md#image) name, the image is tagged with that name, substituting any variables beforehand. See -[variable interpolation](https://github.com/compose-spec/compose-spec/blob/master/spec.md#interpolation). +[variable interpolation](https://github.com/compose-spec/compose-spec/blob/main/spec.md#interpolation). If you change a service's `Dockerfile` or the contents of its build directory, run `docker compose build` to rebuild it. @@ -34,9 +34,9 @@ run `docker compose build` to rebuild it. Services are built once and then tagged, by default as `project-service`. If the Compose file specifies an -[image](https://github.com/compose-spec/compose-spec/blob/master/spec.md#image) name, +[image](https://github.com/compose-spec/compose-spec/blob/main/spec.md#image) name, the image is tagged with that name, substituting any variables beforehand. See -[variable interpolation](https://github.com/compose-spec/compose-spec/blob/master/spec.md#interpolation). +[variable interpolation](https://github.com/compose-spec/compose-spec/blob/main/spec.md#interpolation). If you change a service's `Dockerfile` or the contents of its build directory, run `docker compose build` to rebuild it. diff --git a/docs/reference/compose_restart.md b/docs/reference/compose_restart.md index e9bc161efd7..e57f346a81a 100644 --- a/docs/reference/compose_restart.md +++ b/docs/reference/compose_restart.md @@ -9,8 +9,8 @@ after a container is built, but before the container's command is executed) are after restarting. If you are looking to configure a service's restart policy, refer to -[restart](https://github.com/compose-spec/compose-spec/blob/master/spec.md#restart) -or [restart_policy](https://github.com/compose-spec/compose-spec/blob/master/deploy.md#restart_policy). +[restart](https://github.com/compose-spec/compose-spec/blob/main/spec.md#restart) +or [restart_policy](https://github.com/compose-spec/compose-spec/blob/main/deploy.md#restart_policy). ### Options @@ -33,5 +33,5 @@ after a container is built, but before the container's command is executed) are after restarting. If you are looking to configure a service's restart policy, refer to -[restart](https://github.com/compose-spec/compose-spec/blob/master/spec.md#restart) -or [restart_policy](https://github.com/compose-spec/compose-spec/blob/master/deploy.md#restart_policy). +[restart](https://github.com/compose-spec/compose-spec/blob/main/spec.md#restart) +or [restart_policy](https://github.com/compose-spec/compose-spec/blob/main/deploy.md#restart_policy). diff --git a/docs/reference/compose_stats.md b/docs/reference/compose_stats.md index 43d8bbc33d7..78d44b89350 100644 --- a/docs/reference/compose_stats.md +++ b/docs/reference/compose_stats.md @@ -5,13 +5,13 @@ Display a live stream of container(s) resource usage statistics ### Options -| Name | Type | Default | Description | -|:--------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `-a`, `--all` | `bool` | | Show all containers (default shows just running) | -| `--dry-run` | `bool` | | Execute command in dry run mode | -| `--format` | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates | -| `--no-stream` | `bool` | | Disable streaming stats and only pull the first result | -| `--no-trunc` | `bool` | | Do not truncate output | +| Name | Type | Default | Description | +|:--------------|:---------|:--------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `-a`, `--all` | `bool` | | Show all containers (default shows just running) | +| `--dry-run` | `bool` | | Execute command in dry run mode | +| `--format` | `string` | | Format output using a custom template:
'table': Print output in table format with column headers (default)
'table TEMPLATE': Print output in table format using the given Go template
'json': Print in JSON format
'TEMPLATE': Print output using the given Go template.
Refer to https://docs.docker.com/engine/cli/formatting/ for more information about formatting output with templates | +| `--no-stream` | `bool` | | Disable streaming stats and only pull the first result | +| `--no-trunc` | `bool` | | Do not truncate output | diff --git a/docs/reference/docker_compose_build.yaml b/docs/reference/docker_compose_build.yaml index ade039dc4e3..92285de2efb 100644 --- a/docs/reference/docker_compose_build.yaml +++ b/docs/reference/docker_compose_build.yaml @@ -4,9 +4,9 @@ long: |- Services are built once and then tagged, by default as `project-service`. If the Compose file specifies an - [image](https://github.com/compose-spec/compose-spec/blob/master/spec.md#image) name, + [image](https://github.com/compose-spec/compose-spec/blob/main/spec.md#image) name, the image is tagged with that name, substituting any variables beforehand. See - [variable interpolation](https://github.com/compose-spec/compose-spec/blob/master/spec.md#interpolation). + [variable interpolation](https://github.com/compose-spec/compose-spec/blob/main/spec.md#interpolation). If you change a service's `Dockerfile` or the contents of its build directory, run `docker compose build` to rebuild it. diff --git a/docs/reference/docker_compose_restart.yaml b/docs/reference/docker_compose_restart.yaml index 3b2a4bddd1b..3bc0a3ad83a 100644 --- a/docs/reference/docker_compose_restart.yaml +++ b/docs/reference/docker_compose_restart.yaml @@ -9,8 +9,8 @@ long: |- after restarting. If you are looking to configure a service's restart policy, refer to - [restart](https://github.com/compose-spec/compose-spec/blob/master/spec.md#restart) - or [restart_policy](https://github.com/compose-spec/compose-spec/blob/master/deploy.md#restart_policy). + [restart](https://github.com/compose-spec/compose-spec/blob/main/spec.md#restart) + or [restart_policy](https://github.com/compose-spec/compose-spec/blob/main/deploy.md#restart_policy). usage: docker compose restart [OPTIONS] [SERVICE...] pname: docker compose plink: docker_compose.yaml diff --git a/docs/reference/docker_compose_stats.yaml b/docs/reference/docker_compose_stats.yaml index cd8e801b321..e6854b05a25 100644 --- a/docs/reference/docker_compose_stats.yaml +++ b/docs/reference/docker_compose_stats.yaml @@ -24,7 +24,7 @@ options: 'table TEMPLATE': Print output in table format using the given Go template 'json': Print in JSON format 'TEMPLATE': Print output using the given Go template. - Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates + Refer to https://docs.docker.com/engine/cli/formatting/ for more information about formatting output with templates deprecated: false hidden: false experimental: false