search

Azure / azure-cli

Azure Command-Line Interface
MIT License
3.96k stars 2.94k forks source link

{arcappliance} HTML tags are rendering as empty parameter values in reference docs #29524

Open dbradish-microsoft opened 1 month ago

dbradish-microsoft commented 1 month ago

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

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/arcappliance/create.yml HTML tag 'resourceName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/create.yml HTML tag 'resourceName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/create.yml HTML tag 'resourceName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/createconfig.yml HTML tag 'BridgeName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/createconfig.yml HTML tag 'URL' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/createconfig.yml HTML tag 'PORT' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/createconfig.yml HTML tag 'URL' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/createconfig.yml HTML tag 'PORT' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/createconfig.yml HTML tag 'URL' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/createconfig.yml HTML tag 'PORT' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/createconfig.yml HTML tag 'URL' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/createconfig.yml HTML tag 'PORT' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/createconfig.yml HTML tag 'URL' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/createconfig.yml HTML tag 'PORT' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/createconfig.yml HTML tag 'URL' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/createconfig.yml HTML tag 'PORT' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/delete.yml HTML tag 'resourceName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/delete.yml HTML tag 'BridgeName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/delete.yml HTML tag 'resourceName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/delete.yml HTML tag 'resourceName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/deploy.yml HTML tag 'resourceName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/deploy.yml HTML tag 'BridgeName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/deploy.yml HTML tag 'resourceName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/deploy.yml HTML tag 'resourceName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/logs.yml HTML tag 'BridgeName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/prepare.yml HTML tag 'resourceName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/prepare.yml HTML tag 'BridgeName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/prepare.yml HTML tag 'resourceName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/prepare.yml HTML tag 'resourceName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/run.yml HTML tag 'BridgeName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/troubleshoot/command.yml HTML tag 'BridgeName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/update-infracredentials.yml HTML tag 'BridgeName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/validate.yml HTML tag 'resourceName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/validate.yml HTML tag 'BridgeName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/validate.yml HTML tag 'resourceName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/arcappliance/validate.yml HTML tag 'resourceName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

Related command

az arcappliance

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

yonzhan commented 1 month ago

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

github-actions[bot] commented 1 month ago

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