Azure / azure-cli

Azure Command-Line Interface
MIT License
3.97k stars 2.95k forks source link

{powerbi} HTML tags are rendering as empty parameter values in reference #29619

Open dbradish-microsoft opened 1 month ago

dbradish-microsoft commented 1 month ago

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

Published reference guidelines

Guidelines for Parameters used in examples

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/powerbi/embedded-capacity.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/powerbi/embedded-capacity.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 powerbi

Errors

n/a

Issue script & Debug output

n/a

Expected behavior

n/a

Environment Summary

Azure CLI 2.62.0

Additional context

No response

yonzhan commented 1 month ago

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

microsoft-github-policy-service[bot] commented 1 month ago

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @laurent-mic, @ayeshurun.

ayeshurun commented 1 week ago

@yonzhan @dbradish-microsoft the remove property is defined by the core azure cli package - https://github.com/search?q=repo%3AAzure%2Fazure-cli+%22Remove+a+property+or+an+element+from+a+list.%22&type=code

AllyW commented 1 week ago

Thanks @ayeshurun @dbradish-microsoft for reporting and debugging, these disallowed indexToRemove and value tags are defined in cli.core and would be fixed this sprint.