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

az vm (Core & Extension) | HTML tags are rendering as empty parameter values in reference docs #29577

Open
dbradish-microsoft opened this issue Jul 31, 2024 · 2 comments
Assignees
Labels
Auto-Assign Auto assign by bot Azure CLI Team The command of the issue is owned by Azure CLI team Compute az vm/vmss/image/disk/snapshot question The issue doesn't require a change to the product in order to be resolved. Most issues start as that Similar-Issue
Milestone

Comments

@dbradish-microsoft
Copy link
Contributor

dbradish-microsoft commented Jul 31, 2024

Describe the bug

Problem to solve:

HTML tags in source code are causing build warnings in MicrosoftDocs/azure-docs-cli. More importantly, customer-facing reference docs are not instantiating properly -- parameter values formatted with `<>` are missing. Here's an example:
image

Requested solution:

These values should be escaped with a backtick. Here's an example from az webpubsub.
image

Related GitHub issues:

This is the same issue as these GitHub issues.

List of HTML tag instances that need update:

File name Build error
latest/docs-ref-autogen/vm.yml HTML tag 'Name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/vm.yml HTML tag 'Value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

Related command

az vm

Errors

n/a

Issue script & Debug output

n/a

Expected behavior

n/a

Environment Summary

Azure CLI 2.62.0

Additional context

No response

@dbradish-microsoft dbradish-microsoft added the bug This issue requires a change to an existing behavior in the product in order to be resolved. label Jul 31, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot added the Compute az vm/vmss/image/disk/snapshot label Jul 31, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot added Auto-Assign Auto assign by bot Azure CLI Team The command of the issue is owned by Azure CLI team question The issue doesn't require a change to the product in order to be resolved. Most issues start as that labels Jul 31, 2024
@yonzhan
Copy link
Collaborator

yonzhan commented Jul 31, 2024

Thank you for opening this issue, we will look into it.

@yonzhan yonzhan added this to the Backlog milestone Jul 31, 2024
@yonzhan yonzhan removed the bug This issue requires a change to an existing behavior in the product in order to be resolved. label Jul 31, 2024
@dbradish-microsoft dbradish-microsoft changed the title {vm} HTML tags are rendering as empty parameter values in reference docs az vm (Core & Extension) | HTML tags are rendering as empty parameter values in reference docs Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Auto-Assign Auto assign by bot Azure CLI Team The command of the issue is owned by Azure CLI team Compute az vm/vmss/image/disk/snapshot question The issue doesn't require a change to the product in order to be resolved. Most issues start as that Similar-Issue
Projects
None yet
Development

No branches or pull requests

4 participants