docs(azure-kv-docs) update docs#1245
Conversation
There was a problem hiding this comment.
Pull request overview
This PR refactors the modules/azure-kv documentation workflow to use terraform-docs injection (header/footer + generated tables), adds richer inline variable/output descriptions, and introduces example configurations for consumers.
Changes:
- Added
docs/header.md,docs/footer.md, and.terraform-docs.ymlto standardize terraform-docs generation for the module. - Added/expanded descriptions for module inputs (
variables.tf) and outputs (outputs.tf). - Added
_examples/basicand_examples/comprehensivereference configurations.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| modules/azure-kv/variables.tf | Adds descriptions to inputs (notably access_policies). |
| modules/azure-kv/README.md | Replaced prior content with terraform-docs injection markers. |
| modules/azure-kv/outputs.tf | Adds description to the id output and aligns formatting. |
| modules/azure-kv/main.tf | Updates provider registry documentation links to azurerm 4.21.0. |
| modules/azure-kv/docs/header.md | Introduces module overview, prerequisites, and a minimal usage example. |
| modules/azure-kv/docs/footer.md | Adds examples/resources/support sections for generated README. |
| modules/azure-kv/.terraform-docs.yml | Adds terraform-docs configuration for README injection. |
| modules/azure-kv/_examples/comprehensive/values.reference.yaml | Adds comprehensive YAML reference values for wrappers/tooling. |
| modules/azure-kv/_examples/comprehensive/README.md | Documents the comprehensive reference files. |
| modules/azure-kv/_examples/comprehensive/module.reference.hcl | Adds comprehensive HCL reference module block. |
| modules/azure-kv/_examples/basic/README.md | Adds a minimal example description. |
| modules/azure-kv/_examples/basic/main.tf | Adds a minimal runnable example configuration. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 12 out of 12 changed files in this pull request and generated 7 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 12 out of 12 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 12 out of 12 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 12 out of 12 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 12 out of 12 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
No description provided.