[Feature]: Improve/Enhance guidance around what a good example of a module is

[jtracey93]

Module Name

N/A

Description

From my review of the codex I think it does a great job at covering the composition of the code and tests required for a module but it doesnt really go into the "what a good/bad module is" at a higher level?

For example, we have discussed with @grayzu that resource wrapping single resources is not a great approach and adds little value in most scenarios, think like a module for a resource group or a public IP. On their own these as modules add little value, but as part of something like a Hub Networking module that wraps creating a VNet, Firewall (with Public IP), VPN/ER Gateways etc. then thats much more valuable.

Therefore I think it could be useful for contributors and consumers of these modules to see this more explicitly defined and called out in the codex in this repo. I know there is a link to the hashicorp docs, on a very similar topic in the main codex overview page, but I fear folks won't click through to it (plus its a little open ended and not opinionated)

Example usage

No response

Other information

No response

[zioproto]

@jtracey93 I actively contribute to the AKS module that is mostly all about the azurerm_kubernetes_cluster resource.
However the resource is super complex to configure, and having the module enforcing reasonable defaults and avoiding conflicting options is already an added value.
Users also appreciate the end to end tests so that when a piece of configuration is added to the module, we know it is covered by the end to end tests, and this avoids breaking changes.