docs: use 'docker compose' (v2) consistently in docker/README.md - #263
Open
ygd58 wants to merge 1 commit into
Open
docs: use 'docker compose' (v2) consistently in docker/README.md#263ygd58 wants to merge 1 commit into
ygd58 wants to merge 1 commit into
Conversation
docker/README.md used the legacy hyphenated 'docker-compose' (v1 standalone binary) throughout, while README.md, docs/miner-guide.md, and docs/validator-guide.md all use the modern 'docker compose' (v2 plugin) syntax. Compose v1 has been EOL since July 2023 and isn't installed by default on current Docker Desktop/Engine setups, so following docker/README.md as written can fail with 'command not found' on a fresh install. No behavior change, just aligning the command syntax with the rest of the repo's docs.
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
1 participant
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.
What
docker/README.mdused the legacy hyphenateddocker-compose(v1 standalone binary) in all 10 of its command examples, whileREADME.md,docs/miner-guide.md, anddocs/validator-guide.mdall consistently use the moderndocker compose(v2 plugin) syntax.Why
Docker Compose v1 has been end-of-life since July 2023 and is not installed by default on current Docker Desktop / Docker Engine setups. A new contributor following
docker/README.mdstep by step can hitdocker-compose: command not foundeven thoughdocker composeworks fine. This just aligns the command syntax with the rest of the repo's docs — no behavior or content change otherwise.Change
s/docker-compose/docker compose/gacrossdocker/README.md(10 occurrences).