Skip to content

Commit

Permalink
AVM triage updates (#691)
Browse files Browse the repository at this point in the history
  • Loading branch information
matebarabas authored Feb 27, 2024
1 parent eb6ccdd commit 08c9800
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions docs/content/help-support/issue-triage/avm-issue-triage.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,18 @@ Follow these steps to triage a module proposal:
- Module classification (resource/pattern): "<mark style="background-color:#D3D3D3;">Class: Resource Module 📦</mark>" or "<mark style="background-color:#A9A9A9;">Class: Pattern Module 📦</mark>"
- If it's a module that will be migrated from CARML/TFVM, add the related "<mark style="background-color:#00796F;color:white;">Status: Migrate from CARML 🚛</mark>" or the "<mark style="background-color:#00796F;color:white;">Status: Migrate from TFVM 🚛</mark>" label.

### Triaging pattern modules

As part of the triage of pattern modules, the following points need to be considered/clarified with the module requestor:

- Shouldn't this be a resource module? What makes it a pattern - e.g., does it deploy multiple resources?
- What is it for? What problem does it fix or provides a solution for?
- What is/isn't part of it? Which resource and/or pattern modules are planned to be leveraged in it? Provide a list of resources that would be part of the planned module.
- Where is it coming from/what's backing it - e.g., Azure Architecture Center (AAC), community request, customer example. Provide an architectural diagram and related documentation if possible - or a pointer to these if they are publicly available.
- Don't let the module's scope to grow too big, split it up to multiple smaller ones that are more maintainable - e.g., hub & spoke networking should should be split to a generic hub networking and multiple workload specific spoke networking patterns.
- The module's name should be as descriptive as possible.
- Adopt strict name-to-scope mapping - e.g., hub & spoke networking shouldn't deploy monitoring.

### Scenario 1: Requestor doesn't want to / can't be module owner

{{< hint type=note >}}
Expand Down Expand Up @@ -211,8 +223,8 @@ To look for Orphaned Modules:
5. Remove the information notice (i.e., the file that states that `⚠️THIS MODULE IS CURRENTLY ORPHANED.⚠️, etc.` ):
- In case of a Bicep module:
- Delete the `ORPHANED.md` file from the module's root.
- Run the [`avm/utilities/tools/Set-AVMModule.ps1`](https://github.com/Azure/bicep-registry-modules/blob/main/avm/utilities/tools/Set-AVMModule.ps1) utility with the module path as an input. This removed the re-generates the module’s `README.md` file, so that the `README.md` file will also contain the same notice in its header.
- Make sure the the `README.md` file no longer has the information notice in its header (right after the title).
- Run the [`avm/utilities/tools/Set-AVMModule.ps1`](https://github.com/Azure/bicep-registry-modules/blob/main/avm/utilities/tools/Set-AVMModule.ps1) utility with the module path as an input. This re-generates the module’s `README.md` file, so that it will no longer contain the orphaned module notice in its header.
- Double check the previous steps was successful and the `README.md` file no longer has the information notice in its header (right after the title).
- In case of a Terraform module, remove the information notice from the `README.md` file in the module's root.
- Once the information notice is removed, submit a Pull Request.
6. Use the following text to confirm the new ownership of an orphaned module:
Expand Down

0 comments on commit 08c9800

Please sign in to comment.