From 08c98003c82ee1d1b2256c28a96c200c4d389d5d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A1t=C3=A9=20Barab=C3=A1s?= Date: Mon, 26 Feb 2024 23:12:36 -0800 Subject: [PATCH] AVM triage updates (#691) --- .../issue-triage/avm-issue-triage.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/content/help-support/issue-triage/avm-issue-triage.md b/docs/content/help-support/issue-triage/avm-issue-triage.md index faa5c52d3..2d07f3670 100644 --- a/docs/content/help-support/issue-triage/avm-issue-triage.md +++ b/docs/content/help-support/issue-triage/avm-issue-triage.md @@ -64,6 +64,18 @@ Follow these steps to triage a module proposal: - Module classification (resource/pattern): "Class: Resource Module 📦" or "Class: Pattern Module 📦" - If it's a module that will be migrated from CARML/TFVM, add the related "Status: Migrate from CARML 🚛" or the "Status: Migrate from TFVM 🚛" 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 >}} @@ -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: