Azure / Azure/bicep

Documentation examples offering both ARM and Bicep

Open
#5,884 2 comments 0 reactions 0 assignees View on GitHub
documentation provider improvement
Dominant language
Bicep
Stars
3.6k
Forks
830
Avg merge
1d 21m
Merged PRs (30d)
79

Description

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](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/image-builder-json) 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](https://user-images.githubusercontent.com/11204251/152697055-f97b55b0-a050-4ff9-8ea4-47b8eb37d52c.png)

Contributor guide

Open the contributing guide

Research direction

Start with the linked Azure Image Builder documentation page and inspect how its ARM JSON examples are presented. Define the scope for adding a tabbed ARM/Bicep presentation, then verify that the page exposes equivalent examples in both tabs and that the Bicep version is generated or maintained as intended.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, json
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.