bicep icon indicating copy to clipboard operation
bicep copied to clipboard

Add Clickable Links to Azure Documentation for Resource Types

Open oricawalid opened this issue 11 months ago • 2 comments

I would like to request a new feature for the Bicep extension that enhances the developer experience by allowing users to navigate directly to the official Azure documentation for a given resource type, resource ID, or resource version. This feature would function similarly to how clicking on a module in the extension navigates to its definition.

Proposed Behavior 1. Clickable Resource Type or Name: • When a user hovers over or clicks on a resource type (e.g., Microsoft.Storage/storageAccounts@2023-01-01), it should open the relevant Azure documentation in the browser. • Example: Clicking on Microsoft.Storage/storageAccounts@2023-01-01 would navigate to the Azure documentation page for storage accounts at version 2023-01-01. 2. Clickable Resource ID or Version: • If a resource ID or version is present in the Bicep file, clicking it should navigate to the appropriate documentation for the specific resource. 3. Missing Field Review: • This feature would assist developers in reviewing required fields and available properties for a resource, ensuring they do not miss critical fields during resource definition.

oricawalid avatar Jan 23 '25 23:01 oricawalid

We have a clickable link if you hover over the resource symbol name, but it is difficult to discover:

Image

I think it would be great to make this easier to discover (what you're proposing)

anthony-c-martin avatar Jan 28 '25 21:01 anthony-c-martin

I think we're leaning towards extending the existing hover that shows over the name to also show over the type.

majastrz avatar Mar 05 '25 21:03 majastrz