templating icon indicating copy to clipboard operation
templating copied to clipboard

.NET 6 Documentation Improvements

Open vlada-shubina opened this issue 5 years ago • 2 comments
trafficstars

Requirements

  1. Migrate relevant articles to docs.microsoft.com. Prior to migration, the docs should be verified for completion and correctness
    1. Symbols generators
    2. Value forms
    3. Naming and default value forms
    4. Post actions
    5. Comment syntax
    6. template.json reference
  2. Update existing guidelines on docs.microsoft.com
  3. Create helpful templates for template authors see #2722
  4. Update template.json schema on schemastore.org #2514
  5. Update contributing guidelines in GitHub wiki
  6. Make samples repository available again #2522
  7. Document usage of host.json files.
  8. https://github.com/dotnet/templating/issues/4509

vlada-shubina avatar Sep 17 '20 12:09 vlada-shubina

This would be super helpful. +1 from me

ericsampson avatar Nov 12 '20 17:11 ericsampson

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.

sayedihashimi avatar Apr 20 '21 15:04 sayedihashimi

We decided not to migrate these docs.

YuliiaKovalova avatar May 16 '23 10:05 YuliiaKovalova