docs: expand Docker Compose section and fix YAML comments#3033
Merged
Conversation
lunadogbot
approved these changes
May 14, 2026
lunadogbot
left a comment
Contributor
There was a problem hiding this comment.
Replacing // filepath: (invalid YAML) with title="docker-compose.yml" is the right fix, and the second Compose example with the long-form depends_on.db.condition: service_healthy plus pg_isready healthcheck is valid against Compose v2.
- nit: the
.dockerignore,build-context.sh, andDockerfileblocks switched to# filepath:…comments inside the code rather than thetitle="…"attribute used by the two yaml blocks above.title=works on non-yaml blocks too (see e.g.text title="log.txt"elsewhere in the repo), so moving these three totitle="docker/project-a/.dockerignore"etc. would match the yaml style instead of mixing two conventions in one page. - nit:
last_modified: 2025-12-16in the frontmatter wasn't bumped — adding the ~39-line Postgres Compose example is substantive per the repo's pattern.
- Add multi-service Compose example with Postgres, health checks, volumes, and depends_on - Remove deprecated `version` key from Compose example - Fix invalid `// filepath:` comments in YAML/text blocks to use `#` Closes #2863 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Convert remaining `# filepath:` inline comments in the multi-project section to `title="…"` codeblock attributes, matching the convention used elsewhere in the repo. - In the multi-service Compose example: scope `--allow-net=db:5432`, add `restart: unless-stopped`, drop the unnecessary db host port mapping, and move the password into a `.env`-loaded variable with a short note about secrets.
e2c79f5 to
d770bbb
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
depends_onversionkey from Compose examples// filepath:comments in YAML/text blocks (YAML uses#)Closes #2863
Test plan
🤖 Generated with Claude Code