search

microsoft / vscode-docs

Public documentation for Visual Studio Code
http://code.visualstudio.com/docs
Other
5.66k stars 4.59k forks source link

docker-compose doc references non-existent file #7398

Closed jason-matthew closed 3 months ago

jason-matthew commented 3 months ago

Doc consumers are confused by a unique file reference.

Current doc ( 9c405b7350a5adbcb2d633d09b79fcadb0ee8650/docs/devcontainers/create-dev-container.md#L415 ) contains a single reference to devcontainer.extend.yml. Similarly named docker-compose.extend.yml is referenced 4x in preceding lines.

ntrogh commented 3 months ago

@jason-matthew Thanks for raising this.

ntrogh commented 3 months ago

@bamurtaugh It looks like devcontainer.extend.yml should actually be .devcontainer/docker-compose.extend.yml instead. That way, the development settings override the defaults from the docker-compose.yml file. Can you confirm?

jason-matthew commented 3 months ago

My attempts to stage a doc update has produced https://github.com/microsoft/vscode-docs/pull/7399.

Apologies for the noise.

ntrogh commented 3 months ago

Thanks for creating a PR. Looks good to me, but need @bamurtaugh to review and confirm.