Skip to content

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

@dbradish-microsoft

Description

@dbradish-microsoft

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

Metadata

Metadata

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions