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

{workloads} HTML tags are rendering as empty parameter values in reference docs #29548

Closed
dbradish-microsoft opened this issue Jul 30, 2024 · 2 comments · Fixed by #29898
Closed
Labels
bug This issue requires a change to an existing behavior in the product in order to be resolved. Service Attention This issue is responsible by Azure service team. Similar-Issue

Comments

@dbradish-microsoft
Copy link
Contributor

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/workloads/monitor.yml HTML tag 'indexToRemove' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/workloads/monitor.yml HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/workloads/monitor/sap-landscape-monitor.yml HTML tag 'indexToRemove' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/workloads/monitor/sap-landscape-monitor.yml HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/workloads/sap-virtual-instance.yml HTML tag 'indexToRemove' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/workloads/sap-virtual-instance.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 workloads

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 30, 2024
@yonzhan
Copy link
Collaborator

yonzhan commented Jul 30, 2024

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

Copy link

@yonzhan yonzhan added the Service Attention This issue is responsible by Azure service team. label Jul 30, 2024
@dbradish-microsoft dbradish-microsoft changed the title {workloads} HTML tags aren't allowed in published reference content {workloads} HTML tags are rendering as empty parameter values in reference docs Jul 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue requires a change to an existing behavior in the product in order to be resolved. Service Attention This issue is responsible by Azure service team. Similar-Issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants