Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

{internet-analyzer} HTML tags are rendering as empty parameter values in reference #8090

Open
dbradish-microsoft opened this issue Jul 31, 2024 · 3 comments
Assignees
Labels
Auto-Assign Auto assign by bot Docs Internet Analyzer Service Attention This issue is responsible by Azure service team. Similar-Issue
Milestone

Comments

@dbradish-microsoft
Copy link
Contributor

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

Requested solution:

These values should be escaped with a backtick. Here's an example from az webpubsub.
image

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/internet-analyzer/test.yml HTML tag 'hostname' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/internet-analyzer/test.yml HTML tag 'custom-path' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/internet-analyzer/test.yml HTML tag 'hostname' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/internet-analyzer/test.yml HTML tag 'custom-path' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/internet-analyzer/test.yml HTML tag 'hostname' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/internet-analyzer/test.yml HTML tag 'custom-path' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/internet-analyzer/test.yml HTML tag 'hostname' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/internet-analyzer/test.yml HTML tag 'custom-path' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

Related command

az internet-analyzer

Errors

n/a

Issue script & Debug output

n/a

Expected behavior

n/a

Environment Summary

Azure CLI 2.62.0

Additional context

No response

@dbradish-microsoft dbradish-microsoft added the bug This issue requires a change to an existing behavior in the product in order to be resolved. label Jul 31, 2024
@yonzhan
Copy link
Collaborator

yonzhan commented Jul 31, 2024

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

Copy link

Here are some similar issues that might help you. Please check if they can solve your problem.

@yonzhan yonzhan added Analysis Services Service Attention This issue is responsible by Azure service team. labels Jul 31, 2024
@jsntcy jsntcy added Docs and removed bug This issue requires a change to an existing behavior in the product in order to be resolved. Analysis Services labels Aug 19, 2024
@dbradish-microsoft
Copy link
Contributor Author

dbradish-microsoft commented Aug 21, 2024

According to Azure Internet Analyzer will be retired on 15 March 2024 – delete profiles, Azure Internet Analyzer was retired on March 15, 2024. However, this command group is showing in our reference content as GA.

See the issue here:

source code:
image

Published source code:
doc link

image

@yonzhan yonzhan added this to the Backlog milestone Aug 21, 2024
@dbradish-microsoft dbradish-microsoft transferred this issue from Azure/azure-cli Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Auto-Assign Auto assign by bot Docs Internet Analyzer Service Attention This issue is responsible by Azure service team. Similar-Issue
Projects
None yet
Development

No branches or pull requests

5 participants