From c01d60a858655e9556949cca64b32fd7161f8880 Mon Sep 17 00:00:00 2001 From: Allie Sadler <102604716+aevesdocker@users.noreply.github.com> Date: Tue, 27 Feb 2024 08:06:39 +0000 Subject: [PATCH] Engdocs 2002: minor triage on compose issues (#19511) * clarify base compose file meaning * update name example and reformat link --- content/compose/compose-file/04-version-and-name.md | 4 ++-- content/compose/compose-file/09-secrets.md | 2 +- content/compose/multiple-compose-files/extends.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/content/compose/compose-file/04-version-and-name.md b/content/compose/compose-file/04-version-and-name.md index 0151ce3035..e5ef762535 100644 --- a/content/compose/compose-file/04-version-and-name.md +++ b/content/compose/compose-file/04-version-and-name.md @@ -24,11 +24,11 @@ Whenever a project name is defined by top-level `name` or by some custom mechani [interpolation](12-interpolation.md) and environment variable resolution as `COMPOSE_PROJECT_NAME` ```yml +name: myapp + services: foo: image: busybox - environment: - - COMPOSE_PROJECT_NAME command: echo "I'm running ${COMPOSE_PROJECT_NAME}" ``` diff --git a/content/compose/compose-file/09-secrets.md b/content/compose/compose-file/09-secrets.md index 56bd3fb3dc..b11fef50ab 100644 --- a/content/compose/compose-file/09-secrets.md +++ b/content/compose/compose-file/09-secrets.md @@ -6,7 +6,7 @@ keywords: compose, compose specification, secrets, compose file reference Secrets are a flavor of [Configs](08-configs.md) focusing on sensitive data, with specific constraint for this usage. -Services can only access secrets when explicitly granted by a [`secrets`](05-services.md#secrets) attribute within the `services` top-level element. +Services can only access secrets when explicitly granted by a [`secrets` attribute](05-services.md#secrets) within the `services` top-level element. The top-level `secrets` declaration defines or references sensitive data that is granted to the services in your Compose application. The source of the secret is either `file` or `environment`. diff --git a/content/compose/multiple-compose-files/extends.md b/content/compose/multiple-compose-files/extends.md index e3133b4fe1..8c49499676 100644 --- a/content/compose/multiple-compose-files/extends.md +++ b/content/compose/multiple-compose-files/extends.md @@ -20,7 +20,7 @@ application, with the ability to override some attributes for your own needs. > **Important** > > When you use multiple Compose files, you must make sure all paths in the files -are relative to the base Compose file. This is required because extend files +are relative to the base Compose file (i.e. the Compose file in your main-project folder). This is required because extend files need not be valid Compose files. Extend files can contain small fragments of configuration. Tracking which fragment of a service is relative to which path is difficult and confusing, so to keep paths easier to understand, all paths must