TemplateStudio icon indicating copy to clipboard operation
TemplateStudio copied to clipboard

Improve documentation for creating templates

Open mrlacey opened this issue 4 years ago • 6 comments

  • [ ] Improve documentation on how to author templates.
  • [ ] Add documentation on the packaging and distributing of WinTS compatible templates. This must also include differences from how dotnet-new works with template sources.
  • [ ] Improve tools to help with testing and validating any created templates. Existing tests and tools are a start but these may need updating and revising to make them easier to use outside of the WinTS source. A tool to help with debugging composition filtering issues may also be helpful. This is an area I regularly encounter issues with and would be very hard to debug without stepping through the code. Forcing people to have to step through the code to debug issues with template composition is probably not something we want.

These points will require further refinement/clarification and may be broken into further issues if implementation implemented by different people


This is a follow on from #234 and requires #3392 be implemented first

mrlacey avatar Oct 27 '19 16:10 mrlacey

Updating and improving the documentation at https://github.com/microsoft/TemplateStudio/blob/dev/docs/templates.md should help everyone wanting to contribute to this repo.

mrlacey avatar Feb 03 '22 14:02 mrlacey

Bullet 2 is no longer relevant with the latest refactoring. Bullet 3 I believe is covered by the composition tool in the New Project wizard which shows the composition tree.

mikebattista avatar Apr 18 '22 05:04 mikebattista

Bullet 2 is no longer relevant with the latest refactoring.

" distributing of .... templates. This must also include differences from how dotnet-new works with template sources."

This part is still relevant to inclusion as I believe it provides key information.

mrlacey avatar Apr 18 '22 06:04 mrlacey

CONTRIBUTING.md has been updated.

mikebattista avatar Apr 29 '22 16:04 mikebattista

Bullet 2 is no longer relevant with the latest refactoring.

" distributing of .... templates. This must also include differences from how dotnet-new works with template sources."

This part is still relevant to inclusion as I believe it provides key information.

Can you clarify what you mean by this?

mikebattista avatar Apr 29 '22 16:04 mikebattista

Bullet 2 is no longer relevant with the latest refactoring.

" distributing of .... templates. This must also include differences from how dotnet-new works with template sources." This part is still relevant to inclusion as I believe it provides key information.

Can you clarify what you mean by this?

I thought it worth clearly defining how TS differs from DotNetTemplating in terms of packaging and distribution of templates. This is to avoid someone familiar with DotNetTemplating assuming it works the same way with TS.

mrlacey avatar May 04 '22 20:05 mrlacey