dotnet-docker icon indicating copy to clipboard operation
dotnet-docker copied to clipboard
verified publisher icon dotnet

Update contributor guide regarding consolidated Dockerfile templates

Open mthalman opened this issue 3 years ago • 2 comments

The recent refactoring to the Dockerfile templates (https://github.com/dotnet/dotnet-docker/pull/3404, https://github.com/dotnet/dotnet-docker/pull/3422, https://github.com/dotnet/dotnet-docker/pull/3445) are a significant change from the way things were done before. This should be documented in the contributor guide so people can understand how this all works.

mthalman avatar Feb 02 '22 14:02 mthalman

I don't see the current wording as being overly confusing. That and we don't get a lot of community contributions to begin with. Should we close this?

lbussell avatar Jan 20 '24 00:01 lbussell

It's not that the current documentation is confusing; it's that it's insufficient in describing the complexity. When this doc was originally written, the templates were pretty basic. Now we have a much more complex system.

I think the things that should be described are the following:

  • How to relate a Dockerfile to a template (i.e. look up the mapping in the manifest.json file).
  • Describe the custom Cottle symbols we've defined: VARIABLES and InsertTemplate.

mthalman avatar Jan 22 '24 14:01 mthalman