docs(azure-resource-group): update docs and added examples#894
docs(azure-resource-group): update docs and added examples#894pablosanchezpaz wants to merge 6 commits intomainfrom
Conversation
|
Related to #786 |
There was a problem hiding this comment.
Pull request overview
Updates the Azure Resource Group module documentation and adds a basic example to improve usability and terraform-docs generation.
Changes:
- Added terraform-docs header/footer pages and terraform-docs config for README injection.
- Expanded module README with usage, notes, file structure, and generated inputs/outputs sections.
- Added a basic example (Terraform + values YAML) under
_examples/basic.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| modules/azure-resource-group/docs/header.md | New terraform-docs header content including overview and examples. |
| modules/azure-resource-group/docs/footer.md | New footer with support links. |
| modules/azure-resource-group/_examples/basic/main.tf | Adds a minimal Terraform example for module usage. |
| modules/azure-resource-group/_examples/basic/values.yaml | Adds example values file for the basic example. |
| modules/azure-resource-group/README.md | Replaces README with terraform-docs injected content (header + generated docs + footer). |
| modules/azure-resource-group/.terraform-docs.yml | Adds terraform-docs configuration to generate/inject README content. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Realistic configuration example. | ||
|
|
||
| ## Complete usage example | ||
|
|
There was a problem hiding this comment.
The Markdown fencing is broken here: the ```terraform code block opened on line 15 is never closed before the '### HCL' heading, so the rest of the page will render as code. Close the terraform code fence before the next heading, and ensure each code block is properly opened/closed.
| ## Complete usage example | ||
|
|
||
| ```terraform | ||
| module "githuib-oidc" { |
There was a problem hiding this comment.
Typo in module name: 'githuib' should be 'github' (or rename the module block to something relevant like 'azure_resource_group' since this is an Azure Resource Group module).
| module "githuib-oidc" { | |
| module "azure_resource_group" { |
|
|
||
| ### Set a module | ||
| ## Complete usage example | ||
|
|
There was a problem hiding this comment.
Same Markdown issue as in docs/header.md: the ```terraform code fence is not closed before the '### HCL' heading, which will break rendering of the README. Close the terraform fence before starting the HCL section.
| - Tags help organize and identify your resources. | ||
|
|
||
| ## File structure | ||
|
|
There was a problem hiding this comment.
There’s an extra closing code fence at line 54 (a second ``` immediately after the file-structure block is already closed on line 53). This will introduce an empty code block / malformed Markdown; remove the extra fence.
| color: true | ||
| default: true | ||
| description: false | ||
| escape: true |
There was a problem hiding this comment.
With escape: true, terraform-docs is emitting backslashes into code examples/paths in README (e.g., group\\_one, resource\\_groups.tf), which makes copy/paste invalid for HCL and misleading for file names. Consider setting escape: false (or otherwise adjusting settings/template) so code fences contain literal, copyable values.
| escape: true | |
| escape: false |
No description provided.