Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document templates better #146

Open
detro opened this issue May 31, 2022 · 1 comment
Open

Document templates better #146

detro opened this issue May 31, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@detro
Copy link
Contributor

detro commented May 31, 2022

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 detro added the documentation Improvements or additions to documentation label May 31, 2022
@detro detro added the tf-devex-triage Terraform DevEx project tracking label Jun 13, 2022
@bookshelfdave bookshelfdave added this to the Quality of Life Improvements milestone Jun 27, 2022
@elXaptation
Copy link

@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.

@bflad bflad unassigned detro Aug 1, 2022
@bookshelfdave bookshelfdave removed the tf-devex-triage Terraform DevEx project tracking label Aug 15, 2022
@bflad bflad removed this from the QoL Improvements milestone Jan 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants