{self-help} HTML tags are rendering as empty parameter values in reference docs #29586
Labels
bug
This issue requires a change to an existing behavior in the product in order to be resolved.
Service Attention
This issue is responsible by Azure service team.
Similar-Issue
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:
![image](https://private-user-images.githubusercontent.com/58762114/353569848-5552ae5e-dd43-4376-b8fc-3c6c750707e2.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzkwMTU5NTksIm5iZiI6MTczOTAxNTY1OSwicGF0aCI6Ii81ODc2MjExNC8zNTM1Njk4NDgtNTU1MmFlNWUtZGQ0My00Mzc2LWI4ZmMtM2M2Yzc1MDcwN2UyLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTAyMDglMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwMjA4VDExNTQxOVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTFjNmRlYWU5NTE2MDI1MTM2NWIzNDI3ZDAwNmI2OGJiODNkYjYzNGRmZDg2ZjRkYTkwZDg5ZTZiMTA5YzFlMjAmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.AfWsvwx4gtgqviwvHO_iHDtPvAKlB_7VwyYX0ddJqmg)
Requested solution:
These values should be escaped with a backtick. Here's an example from az webpubsub.
![image](https://private-user-images.githubusercontent.com/58762114/353568500-806899f7-9eca-483e-a175-c486f003b7f4.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzkwMTU5NTksIm5iZiI6MTczOTAxNTY1OSwicGF0aCI6Ii81ODc2MjExNC8zNTM1Njg1MDAtODA2ODk5ZjctOWVjYS00ODNlLWExNzUtYzQ4NmYwMDNiN2Y0LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTAyMDglMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwMjA4VDExNTQxOVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTk5NzU5N2Y0NTQwZmZkMDkyOGNkYWQwOGRiOWVkOWUxZTk3YzExYzg0NjcxZTFlYjc1MGIxMGQ0ZjQ4ZTNmMmEmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.07TfmBu2aYxeCrqd6iHKoUrfZVBZmPp-KVwLp4VfqIg)
Related GitHub issues:
This is the same issue as these GitHub issues.
List of HTML tag instances that need update:
Related command
az self-help
Errors
n/a
Issue script & Debug output
n/a
Expected behavior
n/a
Environment Summary
Azure CLI 2.62.0
Additional context
No response
The text was updated successfully, but these errors were encountered: