Azure / Azure/bicep-registry-modules
[AVM CI Environment Issue]: Child Modules should show accurate examples in their own README's
Open
Needs: Core Team :genie:
Status: Long Term :hourglass_flowing_sand:
Type: AVM :a: :v: :m:
Type: CI :rocket:
Type: Documentation :page_facing_up:
Type: Feature Request :heavy_plus_sign:
- Dominant language
- Bicep
- Stars
- 736
- Forks
- 564
- Avg merge
- 3d 15h
- Merged PRs (30d)
- 30
Description
### Check for previous/existing GitHub issues
- [x] I have checked for previous/existing GitHub issues
### Issue Type?
Feature Request
### Description
Today child modules, like Virtual Network / Subnet, do not show any usage examples so it is down to the consumer to figure it out via intellisense and reading the existing child module README documentation content, such as the parameters etc.
We should add usage examples for child modules, just like we have for "parent" modules, so we can help customers quickly consume the child modules, just like they can for "parents" today.
Contributor guide
Assessment
This issue has not been assessed yet.