Azure / Azure/azure-cli-extensions
az ml and az ml[v1] | HTML tags are rendering as empty parameter values in reference docs
- Dominant language
- Python
- Stars
- 454
- Forks
- 1.7k
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 64
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](https://learn.microsoft.com/en-us/cli/azure/webpubsub?view=azure-cli-latest#az-webpubsub-create-required-parameters).

### Related GitHub issues:
This is the same issue as [these GitHub issues](https://github.com/Azure/azure-cli/issues?q=is%3Aissue+author%3Adbradish-microsoft+HTML+in%3Atitle+).
### List of HTML tag instances that need update:
|File name | Build error |
|-|-|
| latest/docs-ref-autogen/ml/batch-deployment.yml | HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/batch-endpoint.yml | HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/batch-endpoint.yml | HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/component.yml | HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/compute.yml | HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/compute.yml | HTML tag 'ResourceID1' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/compute.yml | HTML tag 'ResourceID2' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/compute.yml | HTML tag 'ResourceID1' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/compute.yml | HTML tag 'ResourceID2' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/connection.yml | HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/data.yml | HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/data.yml | HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/datastore.yml | HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/environment.yml | HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/feature-set.yml | HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/feature-store.yml | HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/feature-store-entity.yml | HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/index.yml | HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/job.yml | HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/job.yml | HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/marketplace-subscription.yml | HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/model.yml | HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/online-deployment.yml | HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/online-endpoint.yml | HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/registry.yml | HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/schedule.yml | HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/serverless-endpoint.yml | HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml/workspace.yml | HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml[v1]/computetarget/attach.yml | HTML tag 'resource' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml[v1]/computetarget/attach.yml | HTML tag 'workspace' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml[v1]/computetarget/attach.yml | HTML tag 'resource' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml[v1]/computetarget/attach.yml | HTML tag 'workspace' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml[v1]/computetarget/attach.yml | HTML tag 'resource' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
| latest/docs-ref-autogen/ml[v1]/computetarget/attach.yml | HTML tag 'workspace' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. |
### Related command
az ml
az ml[v1]
### Errors
n/a
### Issue script & Debug output
n/a
### Expected behavior
n/a
### Environment Summary
This GitHub issue was created at the time of Azure CLI 2.62.0
### Additional context
_No response_
Contributor guide
Assessment
This issue has not been assessed yet.