Azure / bicep

Bicep is a declarative language for describing and deploying Azure resources
MIT License
3.25k stars 753 forks source link

Documentation examples offering both ARM and Bicep #5884

Open wsmelton opened 2 years ago

wsmelton commented 2 years ago

I expect this may be early on in the process but something to just put out as a nice touch to future documentation. It would be cool if pages like this could offer a tabbed view of the code examples to switch between ARM and a generated Bicep equivalent.

I've completely lost where examples of this are in MS docs but a few areas you can find steps are provided in detail and then a section offers performing those steps via Azure CLI, PowerShell or Bash. It would allow for both awareness and syntax if the below was a tab view of ARM (json) and then another tab showed that code converted to Bicep:

image

alex-frankel commented 2 years ago

Most of the docs like this are handled by the individual resource provider teams, not the bicep team. @mumian / @tfitzmac / @davidsmatlak -- do we have any requirements for providing bicep code (in addition to the ARM Template) for docs like this?

@wsmelton -- FWIW, for the content we do provide, we make that available in both languages. Here is the ARM Template & Bicep reference for a virtual machine: https://docs.microsoft.com/azure/templates/microsoft.compute/virtualmachines?tabs=bicep

tfitzmac commented 2 years ago

@wsmelton - thanks for this feedback. We recently completed an inventory of examples for ARM templates, Bicep, and Terraform to figure out where we have gaps. We just started this work so we are still in the planning phase. We hope to start filling those gaps soon.