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

Feature Request: Additional Information Section for Modules in Registry #456

Open
KenSpur opened this issue Oct 30, 2024 · 2 comments
Open

Comments

@KenSpur
Copy link

KenSpur commented Oct 30, 2024

I really appreciate the terraform-docs integration! However, I'm missing a small section to add extra details like my source repo URL, maintainer contact info, and usage examples. This would allow for more comprehensive module documentation directly in the registry.

@PacoVK
Copy link
Owner

PacoVK commented Nov 2, 2024

Hey @KenSpur thanks for the ideas. What exactly do you mean with usage examples? Links to reference projects or actually code gists about how to use a module?

@KenSpur
Copy link
Author

KenSpur commented Nov 4, 2024

Hey @PacoVK, actual code snippets would be ideal. Following Terraform's approach, a dedicated README tab for usage examples etc would be a great addition.

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

No branches or pull requests

2 participants