{ams asset} HTML tag isn't allowed in example syntax

[dbradish-microsoft]

Describe the bug

The source code for ams asset is using HTML tags for examples

Instance 1: https://github.com/MicrosoftDocs/azure-docs-cli/blob/main/latest/docs-ref-autogen/ams/asset.yml#L267
Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.'

Instance 2: https://github.com/MicrosoftDocs/azure-docs-cli/blob/main/latest/docs-ref-autogen/ams/asset.yml#L274
Example: --set property1.property2=<value>.'

Modify these instances to use some other character like a backtick or escape character.

Contributor's Guide guideance:
https://review.learn.microsoft.com/en-us/help/platform/validation-ref/disallowed-html-tag?branch=main

Instance 1 YML syntax looks like this:
summary: 'Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.'

Instance 1 published content renders like this:

This impacts \latest only

• https://github.com/MicrosoftDocs/azure-docs-cli/blob/main/latest/docs-ref-autogen/ams/asset.yml

Related command

az ams asset update --remove
az ams asset update --set

Errors

GitHub build warning:

Issue script & Debug output

See "Describe the bug" section above.

Expected behavior

See "Describe the bug" section above.

Environment Summary

See "Describe the bug" section above.

Additional context

No response

[yonzhan]

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

[microsoft-github-policy-service]

Thank you for your feedback. This has been routed to the support team for assistance.

[azure-client-tools-bot-prd]

Hi @dbradish-microsoft
Find similar issue #27054.

Issue title	{webpubsub} HTML tag isn't allowed in example syntax
Create time	2023-08-01
Comment number	0

Possible solution:
The existing issue is about not being able to delete tags via az tag delete command. The command ends with no errors, but when verifying it by running az tag list, no tag is actually removed. The reason for this is that the tag is bound to some resources, so it cannot be deleted directly with the az tag command. Instead, you can try to delete tags that are bound to some resources at the resource level or resource group level using the az group update or az resource tag commands respectively.

In the case of the new issue, the problem is that HTML tags are being used for examples in the source code for ams asset. This is not allowed and causes issues with rendering the published content. The contributor's guide provides guidance on disallowed HTML tags. To fix this issue, the HTML tags should be removed from the examples in the source code.

---

Please confirm if this resolves your issue.

[ghost]

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @akucer.

Issue Details

---

Describe the bug

The source code for ams asset is using HTML tags for examples

Instance 1: https://github.com/MicrosoftDocs/azure-docs-cli/blob/main/latest/docs-ref-autogen/ams/asset.yml#L267
Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.'

Instance 2: https://github.com/MicrosoftDocs/azure-docs-cli/blob/main/latest/docs-ref-autogen/ams/asset.yml#L274
Example: --set property1.property2=<value>.'

Modify these instances to use some other character like a backtick or escape character.

Contributor's Guide guideance:
https://review.learn.microsoft.com/en-us/help/platform/validation-ref/disallowed-html-tag?branch=main

Instance 1 YML syntax looks like this:
summary: 'Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.'

Instance 1 published content renders like this:

This impacts \latest only

• https://github.com/MicrosoftDocs/azure-docs-cli/blob/main/latest/docs-ref-autogen/ams/asset.yml

Related command

az ams asset update --remove
az ams asset update --set

Errors

GitHub build warning:

Issue script & Debug output

See "Describe the bug" section above.

Expected behavior

See "Describe the bug" section above.

Environment Summary

See "Describe the bug" section above.

Additional context

No response

Author:	dbradish-microsoft
Assignees:	-
Labels:	bug, Service Attention, Media Services, Auto-Assign, Auto-Resolve, Similar-Issue, Possible-Solution
Milestone:	-

[navba-MSFT]

Since this is non-customer reported, Adding Service team to look into this.

[dbradish-microsoft]

@yonzhan, do you know if this issue made it to anyone's backlog to get fixed?

[jiasli]

Duplicate of #27054