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.

Sign up for GitHub

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

Jump to bottom

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

Open
dbradish-microsoft opened this issue Jul 30, 2024 · 2 comments
Open

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

dbradish-microsoft opened this issue Jul 30, 2024 · 2 comments
Labels
Auto-Assign Auto assign by bot 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 Spring Cloud Spring Cloud related issues

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

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
@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 30, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot added the Auto-Assign Auto assign by bot label Jul 30, 2024
@yonzhan
Copy link
Collaborator

yonzhan commented Jul 30, 2024

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

@microsoft-github-policy-service microsoft-github-policy-service bot added the Service Attention This issue is responsible by Azure service team. label Jul 30, 2024
@github-actions GitHub Actions
Copy link

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

@github-actions github-actions bot mentioned this issue Jul 30, 2024
Open
@dbradish-microsoft dbradish-microsoft changed the title {spring-cloud} HTML tags aren't allowed in published reference content {spring-cloud} HTML tags are rendering as empty parameter values in reference docs Jul 31, 2024
@dbradish-microsoft dbradish-microsoft transferred this issue from Azure/azure-cli Oct 8, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot added the Spring Cloud Spring Cloud related issues label Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Auto-Assign Auto assign by bot 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 Spring Cloud Spring Cloud related issues
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@yonzhan @dbradish-microsoft