azure-cli-extensions
azure-cli-extensions copied to clipboard
{load} HTML tags are rendering as empty parameter values in reference
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/load.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/load.yml | HTML tag 'location' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/load.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/load.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/load.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/load.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/load.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 load
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.
Here are some similar issues that might help you. Please check if they can solve your problem.
- Azure/azure-cli#29585
- Azure/azure-cli#29523
- Azure/azure-cli#29534
Fixed by https://github.com/Azure/azure-cli-extensions/pull/8334