Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update composition to allow any folder name for default example #1720

Merged
merged 1 commit into from
Nov 13, 2024
Merged

chore: update composition to allow any folder name for default example #1720

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/content/contributing/terraform/composition.md
View file
Open in desktop
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