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

az storage (Core & Extension) | HTML tags are rendering as empty parameter values in reference docs #29540

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

az storage (Core & Extension) | HTML tags are rendering as empty parameter values in reference docs #29540

dbradish-microsoft opened this issue Jul 30, 2024 · 2 comments
Assignees
@calvinhzy
Labels
Auto-Assign Auto assign by bot Azure CLI Team The command of the issue is owned by Azure CLI team question The issue doesn't require a change to the product in order to be resolved. Most issues start as that Similar-Issue Storage az storage
Milestone
Backlog

Comments

@dbradish-microsoft
Copy link
Contributor

dbradish-microsoft commented Jul 30, 2024 •
edited
Loading

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/storage/account/local-user.yml HTML tag 'keyType' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/storage/account/local-user.yml HTML tag 'keyData' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/storage/account/local-user.yml HTML tag 'keyType' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/storage/account/local-user.yml HTML tag 'keyData' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/storage/account/local-user.yml HTML tag 'keyType' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/storage/account/local-user.yml HTML tag 'keyData' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/storage/account/local-user.yml HTML tag 'keyType' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/storage/account/local-user.yml HTML tag 'keyData' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/storage/account/task-assignment.yml HTML tag 'indexToRemove' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/storage/account/task-assignment.yml HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/storage-actions/task.yml HTML tag 'indexToRemove' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/storage-actions/task.yml HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/storage-mover.yml HTML tag 'indexToRemove' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/storage-mover.yml HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/storage-mover/agent.yml HTML tag 'indexToRemove' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/storage-mover/agent.yml HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/storage-mover/job-definition.yml HTML tag 'indexToRemove' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/storage-mover/job-definition.yml HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/storage-mover/project.yml HTML tag 'indexToRemove' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/storage-mover/project.yml HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

Related command

az storage
az storage-actions
az storage-mover

Environment Summary

Azure CLI 2.62.0
@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
@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 Auto-Assign Auto assign by bot ARM az resource/group/lock/tag/deployment/policy/managementapp/account management-group labels Jul 30, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot added Azure CLI Team The command of the issue is owned by Azure CLI team question The issue doesn't require a change to the product in order to be resolved. Most issues start as that labels 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.

@dbradish-microsoft dbradish-microsoft changed the title {resource-mover} HTML tags aren't allowed in published reference content {storage} HTML tags aren't allowed in published reference content Jul 30, 2024
@yonzhan yonzhan added this to the Backlog milestone Jul 30, 2024
@yonzhan yonzhan assigned calvinhzy and unassigned zhoxing-ms Jul 30, 2024
@yonzhan yonzhan added Storage az storage and removed bug This issue requires a change to an existing behavior in the product in order to be resolved. ARM az resource/group/lock/tag/deployment/policy/managementapp/account management-group labels Jul 30, 2024
@dbradish-microsoft dbradish-microsoft changed the title {storage} HTML tags aren't allowed in published reference content {storage} HTML tags are rendering as empty parameter values in reference docs Jul 31, 2024
@github-actions github-actions bot mentioned this issue Jul 31, 2024
Open
@dbradish-microsoft dbradish-microsoft changed the title {storage} HTML tags are rendering as empty parameter values in reference docs az storage (Core & Extension) | HTML tags are rendering as empty parameter values in reference docs Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@calvinhzy calvinhzy

Labels
Auto-Assign Auto assign by bot Azure CLI Team The command of the issue is owned by Azure CLI team question The issue doesn't require a change to the product in order to be resolved. Most issues start as that Similar-Issue Storage az storage
Projects
None yet
Milestone
Backlog
Development

No branches or pull requests
4 participants
@zhoxing-ms @calvinhzy @yonzhan @dbradish-microsoft