search

Azure / azure-cli

Azure Command-Line Interface
MIT License
4.01k stars 2.99k forks source link

az sf | HTML tags are rendering as empty parameter values in reference docs #29583

Open dbradish-microsoft opened 3 months ago

dbradish-microsoft commented 3 months 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

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/sf/managed-node-type/vm-secret.yml HTML tag 'Base64-encoded-certificate' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/sf/managed-node-type/vm-secret.yml HTML tag 'pfx-file-password' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

Related command

az sf

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 3 months ago

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

microsoft-github-policy-service[bot] commented 3 months ago

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @mwesigwaguma, @a-Santamaria, @LukeSlev, @jkochhar.

mwesigwaguma commented 1 month ago

https://github.com/Azure/azure-cli/pull/29861