Azure / Azure/bicep

To show "View Type Documentation", hover over the actual resource definition

Open
#6,544 3 comments 1 reaction 0 assignees View on GitHub
devdiv enhancement
Dominant language
Bicep
Stars
3.6k
Forks
830
Avg merge
1d 21m
Merged PRs (30d)
79

Description

In customer talks, it's become clear that our "view type definition" feature is not discoverable. I don't think it makes sense for someone to hover over the symbolic name (e.g ucheLikesStorage) in order to be given a link to View Type Documentation.

Current behavior
![image](https://user-images.githubusercontent.com/20650058/163433722-cba069c1-4cc3-4d19-ae56-0e97a676dc32.png)

Proposed:
Instead, I would like for us to create this hover functionality if they hover over a RESOURCE name (e.g 'Microsoft.Storage/storageAccounts@2021-02-01')

Contributor guide

Open the contributing guide

Research direction

Start by locating the existing "View Type Documentation" hover behavior for symbolic names and the hover handling for resource names such as Microsoft.Storage/storageAccounts@2021-02-01. Trace how the resource definition is identified and determine where the documentation link is produced. Done means hovering the actual resource name exposes the documentation action instead of requiring a hover over the symbolic name.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.