azure-cli-extensions
azure-cli-extensions copied to clipboard
{networkfabric} HTML tags are rendering as empty parameter values in reference docs
trafficstars
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/networkfabric/device.yml | HTML tag 'Fabric' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/networkfabric/device.yml | HTML tag 'Rack' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/networkfabric/device.yml | HTML tag 'Device' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
Related command
az networkfabric
Errors
n/a
Issue script & Debug output
n/a
Expected behavior
n/a
Environment Summary
Azure CLI 2.62.0
Additional context
No response
Thank you for opening this issue, we will look into it.
Fixed by https://github.com/Azure/azure-cli-extensions/pull/8344