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

Docs: finish implementing Terraform Docs templates #271

Open
1 task
mitchnielsen opened this issue Oct 1, 2024 · 0 comments
Open
1 task

Docs: finish implementing Terraform Docs templates #271

mitchnielsen opened this issue Oct 1, 2024 · 0 comments
Labels
development good-first-issue maintenance Maintenance work - won't show in release notes open-source

Comments

@mitchnielsen
Copy link
Contributor

Summary

We use https://github.com/hashicorp/terraform-plugin-docs to generate docs, but currently we only use it for the Block resource docs. Let's finish implementing it for the rest of the resources to DRY things up and ensure any changed metadata/schema will be automatically updated in the docs as part of pre-commit/CI.

Acceptance criteria

  • All resources and datasources use terraform-plugin-docs
@mitchnielsen mitchnielsen added bug Something isn't working docs maintenance Maintenance work - won't show in release notes open source and removed bug Something isn't working labels Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
development good-first-issue maintenance Maintenance work - won't show in release notes open-source
Projects
None yet
Development

No branches or pull requests

2 participants