Azure / azure-cli

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

{spring-cloud} HTML tags are rendering as empty parameter values in reference docs #29545

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/spring-cloud/api-portal.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/api-portal.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/api-portal.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/api-portal/custom-domain.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/api-portal/custom-domain.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/api-portal/custom-domain.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/api-portal/custom-domain.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/api-portal/custom-domain.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/binding.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/binding.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/binding.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/binding/cosmos.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/binding/cosmos.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/binding/mysql.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/binding/mysql.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/binding/redis.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/binding/redis.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/custom-domain.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/custom-domain.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/custom-domain.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/custom-domain.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/custom-domain.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/deployment.yml HTML tag 'staging' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/deployment.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/deployment.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/deployment.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/deployment.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/deployment.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/deployment.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/deployment.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/identity.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/identity.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/identity.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/identity.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/app/log.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/application-configuration-service.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/application-configuration-service.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/application-configuration-service.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/application-configuration-service.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/application-configuration-service/git/repo.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/application-configuration-service/git/repo.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/application-configuration-service/git/repo.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/application-configuration-service/git/repo.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/build-service/builder.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/build-service/builder.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/build-service/builder.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/build-service/builder.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/build-service/builder/buildpack-binding.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/build-service/builder/buildpack-binding.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/build-service/builder/buildpack-binding.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/build-service/builder/buildpack-binding.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/build-service/builder/buildpack-binding.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/certificate.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/certificate.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/certificate.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/certificate.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/certificate.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/gateway.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/gateway.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/gateway.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/gateway/custom-domain.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/gateway/custom-domain.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/gateway/custom-domain.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/gateway/custom-domain.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/gateway/custom-domain.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/gateway/route-config.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/gateway/route-config.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/gateway/route-config.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/gateway/route-config.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/gateway/route-config.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/service-registry.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/service-registry.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/service-registry.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/storage.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/storage.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/storage.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/storage.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/storage.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/spring-cloud/storage.yml HTML tag 'name' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

Related command

az spring-cloud

Errors

n/a

Issue script & Debug output

n/a

Expected behavior

n/a

Environment Summary

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.