templating
templating copied to clipboard
.NET 6 Documentation Improvements
Requirements
- Migrate relevant articles to docs.microsoft.com. Prior to migration, the docs should be verified for completion and correctness
- Update existing guidelines on docs.microsoft.com
- Create helpful templates for template authors see #2722
- Update template.json schema on schemastore.org #2514
- Update contributing guidelines in GitHub wiki
- Make samples repository available again #2522
- Document usage of host.json files.
- https://github.com/dotnet/templating/issues/4509
This would be super helpful. +1 from me
The list that you have for docs is good, but I think it would be good to prioritize a step-by-step end-to-end walk through that goes from dotnet new to publishing to nuget.org for the following scenarios.
- How to create a template (single template)
- How to create a template pack (multiple templates in one package)
- How to create a solution template (multi-project template, i.e. solution template)
- How to customize templates for Visual Studio (I can help with this one)
We should make sure to document how sourceName works, and reference that doc in all of the walk throughs. It's a very important concept that almost all template authors will want to leverage. When we document that we should include some details that the string for sourceName should be a complex string (uppercase,lowercase,numbers and special characters), so that the Template Engine can pick the correct transform when creating projects. I think very few template authors are aware of this and how having an all lowercase sourceName can cause problems when the end-user uses the template. I just had an email thread with an internal partner creating templates, and he was bitten by this.
We decided not to migrate these docs.