Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Clickable Links to Azure Documentation for Resource Types #16178

Open
oricawalid opened this issue Jan 23, 2025 · 1 comment
Open

Add Clickable Links to Azure Documentation for Resource Types #16178

oricawalid opened this issue Jan 23, 2025 · 1 comment
Assignees
Labels
enhancement New feature or request Needs: Triage 🔍 Needs: Upvote This issue requires more votes to be considered

Comments

@oricawalid
Copy link

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.

@anthony-c-martin
Copy link
Member

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)

@stephaniezyen stephaniezyen added Needs: Upvote This issue requires more votes to be considered and removed Needs: Triage 🔍 labels Jan 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Needs: Triage 🔍 Needs: Upvote This issue requires more votes to be considered
Projects
Status: Todo
Development

No branches or pull requests

4 participants