microsoft / cobalt

Infrastructure turn-key solution for app service workloads

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Contradictory naming convention

vanillajonathan opened this issue · comments

The Cobalt wiki recommends the abbreviation "asp" for App Service Plan.
https://github.com/microsoft/cobalt/wiki/Azure-Services-Naming-Convention#resource-type-abbreviations

However the Cloud Adaption Framework recommends the name prefix "plan-" for App Service Plan.
https://docs.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/naming-and-tagging#compute-and-web

I have found the same issue in another Azure Resource: Application Insights

This Cobalt wiki suggests "ai",
but Microsoft´s Cloud Adaption Framework suggests "appi".

Naturally and probably there are more incongruencies...

Any update on this? This seems so simple to solve and important.
Both sources (Cobalt and Cloud Adaption Framework) are under Microsoft's name, so they are causing confusion.

I suggest the following solution:
I think the Cloud Adaption Framework seems more like an official documentation for these abbreviations suggestions,
so maybe this Cobalt wiki should at least inform that:
".... Although this project uses its own abbreviations convention, there is another option too, listed in Microsoft´s Cloud Adaption Framework"