Skip to content

Commit

Permalink
chore: update composition to allow any folder name for default example (
Browse files Browse the repository at this point in the history
  • Loading branch information
jaredfholgate authored Nov 13, 2024
1 parent 1da86f3 commit 80d546a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/content/contributing/terraform/composition.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ See template repo [here](https://github.com/Azure/terraform-azurerm-avm-template
- `unit/` - (optional, may use further sub-directories if required)
- `modules/` - (for sub-modules only if used)
- `examples/` - (all examples must deploy without successfully without requiring input - these are customer facing)
- `defaults` - (minimum/required parameters/variables only, heavy reliance on the default values for other parameters/variables)
- `<at least one folder>` - (at least one example that uses the variable defaults minimum/required parameters/variables only)
- `<other folders for examples as required>`
- `/...` - (Module files that live in the root of module directory)
- `_header.md` - (required for documentation generation)
Expand Down Expand Up @@ -98,7 +98,7 @@ See template repo [here](https://github.com/Azure/terraform-azurerm-avm-template
│ ├───extensions.json
│ └───settings.json
├───examples/
│ ├───default/
│ ├───<example_folder>/
│ │ ├───README.md
│ │ ├───_footer.md
│ │ ├───_header.md
Expand Down

0 comments on commit 80d546a

Please sign in to comment.