search

Azure / Azure-Verified-Modules

Azure Verified Modules (AVM) is an initiative to consolidate and set the standards for what a good Infrastructure-as-Code module looks like. Modules will then align to these standards, across languages (Bicep, Terraform etc.) and will then be classified as AVMs and available from their respective language specific registries.
https://aka.ms/AVM
MIT License
345 stars 81 forks source link

[Documentation Update]: Module names - clarity #1621

Open jbinko opened 23 hours ago

jbinko commented 23 hours ago

Check for previous/existing GitHub issues

Description

The following sections describe the naming conventions for modules, but contributors are not required to create these names themselves. Instead, we should direct them to the csv link where they can find the pre-assigned module names. https://azure.github.io/Azure-Verified-Modules/specs/shared/#naming-convention https://azure.github.io/Azure-Verified-Modules/specs/shared/#bicep-resource-module-naming https://azure.github.io/Azure-Verified-Modules/specs/shared/#bicep-pattern-module-naming

I suggest adding notes in the links above with pointer to csv to recommend that contributors utilize existing module names.

You can find the existing names of modules here: https://github.com/Azure/Azure-Verified-Modules/blob/main/docs/static/module-indexes/BicepResourceModules.csv

This approach prevents any confusion for new contributors attempting to devise module names based on complex naming conventions.

microsoft-github-policy-service[bot] commented 23 hours ago

[!IMPORTANT] The "Needs: Triage :mag:" label must be removed once the triage process is complete!

[!TIP] For additional guidance on how to triage this issue/PR, see the AVM Issue Triage documentation.

eriqua commented 23 hours ago

Hi @jbinko, thanks for raising this issue.

Module names are not preassigned, but provided by contributors raising a module proposal. Only after that the module name will be listed in the csv file. Hence, contributors should be aware of the naming convention before the name is listed.

Could you please elaborate more on which part of the documentation is unclear in that sense? Exactly which phase of the contribution are we talking about (e.g., before the module proposal/after the proposal but before the first release/update of an existing module)?

Thanks!