terraform-plugin-docs icon indicating copy to clipboard operation
terraform-plugin-docs copied to clipboard

Document templates better

Open detro opened this issue 3 years ago • 2 comments

Today we document that it's possible to provide templates instead of the auto-generated ones, but we don't provide:

  • A documentation showing how those templates look like
  • Don't mention explicitly that, if used, then it's entirely up to the user what goes in there

detro avatar May 31 '22 18:05 detro

@detro I use the generate arg --website-temp-dir to see the default generated templates.

Example: tfplugindocs generate --website-temp-dir /tmp/blah101

You'll find the *.md.tmpl files in /tmp/blah101. I then can decide what I want to tweak in my /templates/[resource/data-source/*.md.tmpl files.

elXaptation avatar Jul 26 '22 07:07 elXaptation