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

Module support #194

Open
tylerFowler opened this issue Nov 4, 2022 · 2 comments
Open

Module support #194

tylerFowler opened this issue Nov 4, 2022 · 2 comments
Labels
enhancement New feature or request

Comments

@tylerFowler
Copy link

Are there any plans to support documentation generation for Terraform Module codebases in the same fashion as providers?

@bflad bflad added enhancement New feature or request tf-devex-triage labels Nov 10, 2022
@bflad
Copy link
Contributor

bflad commented Nov 10, 2022

Hi @tylerFowler 👋 Thank you for raising this!

The design scope of this tool was intended to be for provider documentation only. That being said, I have added this to our team's next triage meeting to discuss this further just to ensure we don't want to change that stance.

There are some existing community tools that can generate Terraform module documentation, such as https://terraform-docs.io/, which has been around for quite some time now and is well vetted in the module ecosystem.

@tylerFowler
Copy link
Author

Indeed, I was surprised that this tool didn't cover that scope after seeing a lot of nice, clearly auto-generated docs for modules in the official registry - so the scope made sense to me at first glance. However if the official recommendation is to use terraform-docs that's also fine with me, it seems like a quality tool as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants