microsoft / microsoft/vscode-docs
Rename all `docker-compose.y[a]ml` to `compose.yaml`
Nobody has claimed this yet.
- Dominant language
- Markdown
- Stars
- 6.6k
- Forks
- 5.8k
- Avg merge
- 11h 43m
- Merged PRs (30d)
- 123
Description
The compose spec specifies (https://docs.docker.com/compose/compose-file/03-compose-file/):
The default path for a Compose file is
compose.yaml(preferred) orcompose.ymlthat is placed in the working directory. Compose also supportsdocker-compose.yamlanddocker-compose.ymlfor backwards compatibility of earlier versions. If both files exist, Compose prefers the canonicalcompose.yaml.
All mentions of docker-compose.yml and docker-compose.yaml should be changed to compose.yaml.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the vscode-docs repository for all mentions of docker-compose.yml and docker-compose.yaml. Replace those mentions with compose.yaml, then search again to confirm the legacy names no longer appear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100