From 5fe707ad228f3f815f0138eeee6feca676eaa964 Mon Sep 17 00:00:00 2001 From: Allie Sadler <102604716+aevesdocker@users.noreply.github.com> Date: Tue, 1 Oct 2024 12:55:42 +0100 Subject: [PATCH] compose-callouts (#21039) * compose-callouts * reorder --- .../compose/how-tos/environment-variables/envvars.md | 12 ++++-------- .../set-environment-variables.md | 2 +- content/manuals/compose/how-tos/file-watch.md | 6 +++--- .../compose/how-tos/multiple-compose-files/_index.md | 1 + content/manuals/compose/install/standalone.md | 6 ++---- content/manuals/compose/install/uninstall.md | 4 ++-- content/manuals/compose/releases/migrate.md | 2 +- 7 files changed, 14 insertions(+), 19 deletions(-) diff --git a/content/manuals/compose/how-tos/environment-variables/envvars.md b/content/manuals/compose/how-tos/environment-variables/envvars.md index 755463ad97c..8531e707216 100644 --- a/content/manuals/compose/how-tos/environment-variables/envvars.md +++ b/content/manuals/compose/how-tos/environment-variables/envvars.md @@ -159,6 +159,8 @@ If `COMPOSE_ENV_FILES` is not set, and you don't provide `--env-file` in the CLI ### COMPOSE\_MENU +> Available in Docker Compose version [2.26.0](/manuals/compose/releases/release-notes.md#2260) and later, and Docker Desktop version 4.29 and later. + When enabled, Compose displays a navigation menu where you can choose to open the Compose stack in Docker Desktop, switch on [`watch` mode](../file-watch.md), or use [Docker Debug](/reference/cli/docker/debug.md). * Supported values: @@ -166,12 +168,10 @@ When enabled, Compose displays a navigation menu where you can choose to open th * `false` or `0`, to disable. * Defaults to: `1` if you obtained Docker Compose through Docker Desktop, otherwise default is `0`. -> [!NOTE] -> -> Available in Docker Compose version 2.26.0 and later, and Docker Desktop version 4.29 and later - ### COMPOSE\_EXPERIMENTAL +> Available in Docker Compose version [2.26.0](/manuals/compose/releases/release-notes.md#2260) and later, and Docker Desktop version 4.29 and later. + This is an opt-out variable. When turned off it deactivates the experimental features such as the navigation menu or [Synchronized file shares](/manuals/desktop/synchronized-file-sharing.md). * Supported values: @@ -179,10 +179,6 @@ This is an opt-out variable. When turned off it deactivates the experimental fea * `false` or `0`, to disable. * Defaults to: `1`. -> [!NOTE] -> -> Available in Docker Compose version 2.26.0 and later, and Docker Desktop version 4.29 and later - ## Unsupported in Compose V2 The following environment variables have no effect in Compose V2. diff --git a/content/manuals/compose/how-tos/environment-variables/set-environment-variables.md b/content/manuals/compose/how-tos/environment-variables/set-environment-variables.md index eebce7ad166..cdf70b2009d 100644 --- a/content/manuals/compose/how-tos/environment-variables/set-environment-variables.md +++ b/content/manuals/compose/how-tos/environment-variables/set-environment-variables.md @@ -12,7 +12,7 @@ aliases: A container's environment is not set until there's an explicit entry in the service configuration to make this happen. With Compose, there are two ways you can set environment variables in your containers with your Compose file. ->**Tip** +>[!TIP] > > Don't use environment variables to pass sensitive information, such as passwords, in to your containers. Use [secrets](../use-secrets.md) instead. diff --git a/content/manuals/compose/how-tos/file-watch.md b/content/manuals/compose/how-tos/file-watch.md index 889223c984f..365c0d60ade 100644 --- a/content/manuals/compose/how-tos/file-watch.md +++ b/content/manuals/compose/how-tos/file-watch.md @@ -98,7 +98,7 @@ If `action` is set to `sync+restart`, Compose synchronizes your changes with the `sync+restart` is ideal when config file changes, and you don't need to rebuild the image but just restart the main process of the service containers. It will work well when you update a database configuration or your `nginx.conf` file for example ->**Tip** +>[!TIP] > > Optimize your `Dockerfile` for speedy incremental rebuilds with [image layer caching](/build/cache) @@ -189,12 +189,12 @@ This setup demonstrates how to use the `sync+restart` action in Docker Compose t {{< include "compose/configure-watch.md" >}} -> [!TIP] +> [!NOTE] > > Watch can also be used with the dedicated `docker compose watch` command if you don't want to > get the application logs mixed with the (re)build logs and filesystem sync events. -> **Looking for a sample project to test things out?** +> [!TIP] > > Check out [`dockersamples/avatars`](https://github.com/dockersamples/avatars), > or [local setup for Docker docs](https://github.com/docker/docs/blob/main/CONTRIBUTING.md) diff --git a/content/manuals/compose/how-tos/multiple-compose-files/_index.md b/content/manuals/compose/how-tos/multiple-compose-files/_index.md index 305e923d964..d7e9dc78a0d 100644 --- a/content/manuals/compose/how-tos/multiple-compose-files/_index.md +++ b/content/manuals/compose/how-tos/multiple-compose-files/_index.md @@ -3,6 +3,7 @@ description: General overview for the different ways you can work with multiple files in Docker Compose keywords: compose, compose file, merge, extends, include, docker compose, -f flag linkTitle: Use multiple Compose files +title: Use multiple Compose files weight: 80 aliases: - /compose/multiple-compose-files/ diff --git a/content/manuals/compose/install/standalone.md b/content/manuals/compose/install/standalone.md index 9ef55f81491..d2908157dcc 100644 --- a/content/manuals/compose/install/standalone.md +++ b/content/manuals/compose/install/standalone.md @@ -9,7 +9,7 @@ On this page you can find instructions on how to install Compose standalone on L ### On Linux -> **Compose standalone** +> [!WARNING] > > Note that Compose standalone uses the `-compose` syntax instead of the current standard syntax `compose`. >For example type `docker-compose up` when using Compose standalone, instead of `docker compose up`. @@ -48,6 +48,7 @@ on Microsoft Windows Server and want to install Docker Compose. ```powershell Start-BitsTransfer -Source "https://github.com/docker/compose/releases/download/{{% param "compose_version" %}}/docker-compose-windows-x86_64.exe" -Destination $Env:ProgramFiles\Docker\docker-compose.exe ``` + To install a different version of Compose, substitute `{{% param "compose_version" %}}` with the version of Compose you want to use. > [!NOTE] > @@ -55,9 +56,6 @@ on Microsoft Windows Server and want to install Docker Compose. Because this directory is registered in the system `PATH`, you can run the `docker-compose --version` command on the subsequent step with no additional configuration. - > To install a different version of Compose, substitute `{{% param "compose_version" %}}` - > with the version of Compose you want to use. - 4. Test the installation. ```console diff --git a/content/manuals/compose/install/uninstall.md b/content/manuals/compose/install/uninstall.md index 12e373e1852..a57d76b1cbb 100644 --- a/content/manuals/compose/install/uninstall.md +++ b/content/manuals/compose/install/uninstall.md @@ -46,11 +46,11 @@ Or, if you have installed Compose for all users, run: $ rm /usr/local/lib/docker/cli-plugins/docker-compose ``` -> Got a **Permission denied** error? +> [!NOTE] > > If you get a **Permission denied** error using either of the above > methods, you do not have the permissions allowing you to remove -> `docker-compose`. To force the removal, prepend `sudo` to either of the above instructions and run it again. +> Docker Compose. To force the removal, prepend `sudo` to either of the above instructions and run it again. ### Inspect the location of the Compose CLI plugin diff --git a/content/manuals/compose/releases/migrate.md b/content/manuals/compose/releases/migrate.md index fdb320c1355..5732e6349c0 100644 --- a/content/manuals/compose/releases/migrate.md +++ b/content/manuals/compose/releases/migrate.md @@ -124,7 +124,7 @@ Additionally, a new [docker/compose-bin image on Docker Hub](https://hub.docker. Yes. You can still download and install Compose V1 packages, but you won't get support from Docker if anything breaks. ->**Warning** +>[!WARNING] > > The final Compose V1 release, version 1.29.2, was May 10, 2021. These packages haven't received any security updates since then. Use at your own risk.