az sig (core & extension) | HTML tags are rendering as empty parameter values in reference docs

[dbradish-microsoft]

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:

Requested solution:

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

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/sig/image-version.yml	HTML tag 'edge' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/sig/image-version.yml	HTML tag 'lun1' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/sig/image-version.yml	HTML tag 'lun2' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/sig/image-version.yml	HTML tag 'region' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/sig/image-version.yml	HTML tag 'edge' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/sig/image-version.yml	HTML tag 'replica' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/sig/image-version.yml	HTML tag 'storage' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/sig/image-version.yml	HTML tag 'MajorVersion' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/sig/image-version.yml	HTML tag 'MinorVersion' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/sig/image-version.yml	HTML tag 'Patch' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/sig/image-version.yml	HTML tag 'MajorVersion' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/sig/image-version.yml	HTML tag 'MinorVersion' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/sig/image-version.yml	HTML tag 'Patch' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/sig/image-version.yml	HTML tag 'region' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/sig/image-version.yml	HTML tag 'edge' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/sig/image-version.yml	HTML tag 'replica' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/sig/image-version.yml	HTML tag 'storage' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

Related command

az sig

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]

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

[github-actions]

Here are some similar issues that might help you. Please check if they can solve your problem.

• {devcenter} HTML tags are rendering as empty parameter values in reference docs #29531
• az functionapp (both Core and Extension) | HTML tags are rendering as empty parameter values in reference docs #29534
• {sentinel} HTML tags are rendering as empty parameter values in reference docs #29541