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.

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

{postgres} HTML tag isn't allowed in example syntax #27058

Closed
dbradish-microsoft opened this issue Aug 1, 2023 · 10 comments
Closed

{postgres} HTML tag isn't allowed in example syntax #27058

dbradish-microsoft opened this issue Aug 1, 2023 · 10 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. PostgreSQL Service Attention This issue is responsible by Azure service team.

Comments

@dbradish-microsoft
Copy link
Contributor

Describe the bug

The source code for postgres server is using HTML tags for examples.

There are eight instances:
https://github.com/MicrosoftDocs/azure-docs-cli/blob/main/latest/docs-ref-autogen/postgres/flexible-server.yml

  1. Line 986: HTML tag 'indexToRemove' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  2. Line 993: HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

https://github.com/MicrosoftDocs/azure-docs-cli/blob/main/latest/docs-ref-autogen/postgres/server.yml

  1. Line 79: HTML tag 'SingleIP' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  2. Line 79: HTML tag 'StartIP-DestinationIP' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  3. Line 417: HTML tag 'SingleIP' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  4. Line 417: HTML tag 'StartIP-DestinationIP' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  5. Line 421: HTML tag 'indexToRemove' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  6. Line 428: HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

All eight instances render as blank in our autogenerated reference content. Modify these instances to use some other character like a backtick or escape character.

Contributor's Guide guideance:
https://review.learn.microsoft.com/en-us/help/platform/validation-ref/disallowed-html-tag?branch=main

Related command

az postgres flexible-server update --remove
az postgres flexible-server update --set

az postgres server create --public --public-network-access

az postgres server update --public --public-network-access
az postgres server update --public --remove
az postgres server update --public --set

Errors

MicrosoftDocs/azure-docs-cli warning:

image

Issue script & Debug output

See "Describe the bug" section above.

Expected behavior

See "Describe the bug" section above.

Environment Summary

See "Describe the bug" section above.

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 Aug 1, 2023
@ghost ghost added Auto-Assign Auto assign by bot CXP Attention This issue is handled by CXP team. PostgreSQL labels Aug 1, 2023
@yonzhan
Copy link
Collaborator

yonzhan commented Aug 1, 2023

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

@microsoft-github-policy-service
Copy link
Contributor

Thank you for your feedback. This has been routed to the support team for assistance.

@navba-MSFT navba-MSFT added Service Attention This issue is responsible by Azure service team. and removed CXP Attention This issue is handled by CXP team. labels Aug 2, 2023
@ghost
Copy link

ghost commented Aug 2, 2023

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @sunilagarwal, @lfittl-msft, @sr-msft, @niklarin.

Issue Details

Describe the bug

The source code for postgres server is using HTML tags for examples.

There are eight instances:
https://github.com/MicrosoftDocs/azure-docs-cli/blob/main/latest/docs-ref-autogen/postgres/flexible-server.yml

  1. Line 986: HTML tag 'indexToRemove' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  2. Line 993: HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

https://github.com/MicrosoftDocs/azure-docs-cli/blob/main/latest/docs-ref-autogen/postgres/server.yml

  1. Line 79: HTML tag 'SingleIP' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  2. Line 79: HTML tag 'StartIP-DestinationIP' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  3. Line 417: HTML tag 'SingleIP' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  4. Line 417: HTML tag 'StartIP-DestinationIP' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  5. Line 421: HTML tag 'indexToRemove' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  6. Line 428: HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

All eight instances render as blank in our autogenerated reference content. Modify these instances to use some other character like a backtick or escape character.

Contributor's Guide guideance:
https://review.learn.microsoft.com/en-us/help/platform/validation-ref/disallowed-html-tag?branch=main

Related command

az postgres flexible-server update --remove
az postgres flexible-server update --set

az postgres server create --public --public-network-access

az postgres server update --public --public-network-access
az postgres server update --public --remove
az postgres server update --public --set

Errors

MicrosoftDocs/azure-docs-cli warning:

image

Issue script & Debug output

See "Describe the bug" section above.

Expected behavior

See "Describe the bug" section above.

Environment Summary

See "Describe the bug" section above.

Additional context

No response

Author: dbradish-microsoft
Assignees: -
Labels:

bug, Service Attention, PostgreSQL, Auto-Assign

Milestone: -

@navba-MSFT
Copy link
Contributor

Since this is non-customer reported, Adding Service team to look into this.

@dbradish-microsoft
Copy link
Contributor Author

@yonzhan, do you know if this issue made it to anyone's backlog to get fixed?

@jiasli
Copy link
Member

jiasli commented Nov 3, 2023

For

  • az postgres flexible-server update --remove
  • az postgres flexible-server update --set
  • az postgres server update --public --remove
  • az postgres server update --public --set

This issue is a duplicate of #27054

@dbradish-microsoft
Copy link
Contributor Author

@jiasli, There are six GitHub issues for HTML tags -- one for each reference group.

@jiasli
Copy link
Member

jiasli commented Nov 9, 2023

@dbradish-microsoft, thanks for the kind reminder. I am using #27054 as the main tracking issue.

@nachoalonsoportillo
Copy link
Contributor

@yonzhan it seems this one was addressed with #27752. Please, proceed with closing it. Thanks!

@nachoalonsoportillo
Copy link
Contributor

@yonzhan Please, close this one. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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. PostgreSQL Service Attention This issue is responsible by Azure service team.
Projects
None yet
Development

No branches or pull requests

5 participants