Open
Description
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.
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/iot/central/app.yml | HTML tag 'subdomain' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/iot/central/device-template.yml | HTML tag 'Device' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/iot/central/device-template.yml | HTML tag 'Device' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/iot/central/export.yml | HTML tag 'Export' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/iot/central/export/destination.yml | HTML tag 'Destination' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/iot/central/job.yml | HTML tag 'Job' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/iot/device.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/iot/device.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/iot/device.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/iot/device.yml | HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
Related command
az iot
Errors
n/a
Issue script & Debug output
n/a
Expected behavior
n/a
Environment Summary
Azure CLI 2.62.0
Additional context
No response
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment