auto-docs doesn't make the expected example

[kewalaka]

Autodocs is adding main.tf just below the header:

terraform-azurerm-avm-res-keyvault-vault/modules/.terraform-docs.yml

Line 24 in 7bd06e3

{{ include "main.tf" }}

This isn't how the submodule is called, it should be more like this:

module "avm-res-keyvault-vault-secret" {
  source = "Azure/terraform-azurerm-avm-res-keyvault-vault/azurerm//modules/secret"
  version = "x.y.z"

  key_vault_resource_id = azurerm_keyvault.existing_vault.id

  # etc, other params

  # optionally
  role_assignments = {
     # etc
  }
}

[microsoft-github-policy-service]

Important

The "Needs: Triage 🔍" label must be removed once the triage process is complete!

Tip

For additional guidance on how to triage this issue/PR, see the TF Issue Triage documentation.

[matt-FFFFFF]

This is one for the team to consider... thanks for raising