docs(azure-customrole): update docs and added examples#907
Draft
pablosanchezpaz wants to merge 4 commits intomainfrom
Draft
docs(azure-customrole): update docs and added examples#907pablosanchezpaz wants to merge 4 commits intomainfrom
pablosanchezpaz wants to merge 4 commits intomainfrom
Conversation
Contributor
Author
|
Related to #786 |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Azure Custom Role module documentation by introducing terraform-docs header/footer templates and adding a basic runnable example.
Changes:
- Added terraform-docs header/footer markdown files and terraform-docs configuration.
- Regenerated
README.mdcontent (requirements/providers/inputs/outputs) and appended examples/resources/support sections. - Added a basic example (
_examples/basic) withmain.tfand avalues.yaml.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| modules/azure-customrole/docs/header.md | Adds a shared header template for terraform-docs output. |
| modules/azure-customrole/docs/footer.md | Adds a shared footer template with links to examples/resources/support. |
| modules/azure-customrole/_examples/basic/values.yaml | Adds YAML-based example values for role definition inputs. |
| modules/azure-customrole/_examples/basic/main.tf | Adds a minimal module usage example. |
| modules/azure-customrole/README.md | Regenerated docs with header/footer injection and updated inputs/outputs/examples sections. |
| modules/azure-customrole/.terraform-docs.yml | Adds terraform-docs configuration to inject header/footer into README. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| } | ||
| } | ||
| ``` | ||
| | <a name="output_id"></a> [id](#output\_id) | # OUTPUTS SECTION Role Definition Id | |
There was a problem hiding this comment.
The output description appears to be a placeholder (# OUTPUTS SECTION ...) and the leading # may also render oddly inside a Markdown table. Replace it with a user-facing description (e.g., what the id represents) consistent with the rest of the README.
Suggested change
| | <a name="output_id"></a> [id](#output\_id) | # OUTPUTS SECTION Role Definition Id | | |
| | <a name="output_id"></a> [id](#output\_id) | The ID of the created custom role definition. | |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.