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.

Sign up for GitHub

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

Jump to bottom

Using a %20 (space) in documentationUri will not produce a link when hoovering over the module #10567

Closed
akata72 opened this issue Apr 29, 2023 · 3 comments · Fixed by #11365
Closed

Using a %20 (space) in documentationUri will not produce a link when hoovering over the module #10567

akata72 opened this issue Apr 29, 2023 · 3 comments · Fixed by #11365
Assignees
@StephenWeatherford
Labels
bug Something isn't working devdiv Related to Bicep tooling efforts in DevDiv P2 This is important to be completed, but you may not get to it
Milestone
v0.20

Comments

@akata72
Copy link

akata72 commented Apr 29, 2023 •
edited
Loading

Bicep version
0.16.2

Describe the bug

If you publish a module using the documentationUri option, and the Uri contains %20 (to represent a space). This is not honored when displaying the link in vscode (when you hoover over the module). It seems that %20 is replaced with an actual space (wich might be natural) --- but then the link is not "clickable" anymore. We noticed this because our Azure DevOps project contains a space in the name.
image

To Reproduce
Publish anything to the module with a Uri containing %20 and look at the result.

Additional context
It should probably publish the actual Uri that gets passed when publishing.
@ghost ghost added the Needs: Triage 🔍 label Apr 29, 2023
@alex-frankel alex-frankel added bug Something isn't working devdiv Related to Bicep tooling efforts in DevDiv labels May 2, 2023
@puicchan puicchan added this to the v0.18 milestone May 3, 2023
@StephenWeatherford StephenWeatherford modified the milestones: v0.18, v0.19 May 25, 2023
@puicchan puicchan added the P2 This is important to be completed, but you may not get to it label May 25, 2023
@puicchan puicchan modified the milestones: v0.19, v0.20 May 30, 2023
@StephenWeatherford
Copy link
Contributor

Manifest looks good:
"annotations": {
"org.opencontainers.image.documentation": "https://raw.githubusercontent.com/StephenWeatherford/template-examples/master/bugs/10567/my%20doc%20page.html"
}

@StephenWeatherford
Copy link
Contributor

image

@StephenWeatherford StephenWeatherford mentioned this issue Jul 26, 2023
Merged
StephenWeatherford added a commit that referenced this issue Jul 26, 2023
@StephenWeatherford
Fix hover with escaped chars in published doclink (#11365)
c0e9bd8 
Fixes #10567
###### Microsoft Reviewers:
codeflow:open?pullrequest=https://github.com/Azure/bicep/pull/11365&drop=dogfoodAlpha

---------

Co-authored-by: Stephen Weatherford <Stephen.Weatherford.com>
@akata72
Copy link
Author

akata72 commented Aug 14, 2023

Great! Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@StephenWeatherford StephenWeatherford

Labels
bug Something isn't working devdiv Related to Bicep tooling efforts in DevDiv P2 This is important to be completed, but you may not get to it
Projects
Bicep
Archived in project
Milestone
v0.20
Development

Successfully merging a pull request may close this issue.

Fix hover with escaped chars in published doclink Azure/bicep
4 participants
@StephenWeatherford @puicchan @alex-frankel @akata72