{doc} Fix disallowed html tags #30424
Merged
+76
−76
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Jing-song
requested review from
zhoxing-ms,
jsntcy,
wangzelin007,
yanzhudd,
evelyn-ys,
calvinhzy,
kairu-ms,
jiasli,
bebound,
necusjz and
AllyW
as code owners
️✔️AzureCLI-FullTest
|
|
Hi @Jing-song, |
️✔️AzureCLI-BreakingChangeTest
|
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
/azp run |
|
Azure Pipelines successfully started running 3 pipeline(s). |
bebound
reviewed
Dec 2, 2024
AllyW
reviewed
Dec 4, 2024
AllyW
reviewed
Dec 4, 2024
AllyW
reviewed
Dec 4, 2024
src/azure-cli/azure/cli/command_modules/containerapp/_params.py
Outdated
Show resolved
Hide resolved
AllyW
reviewed
Dec 4, 2024
src/azure-cli/azure/cli/command_modules/containerapp/_params.py
Outdated
Show resolved
Hide resolved
AllyW
reviewed
Dec 4, 2024
AllyW
reviewed
Dec 4, 2024
AllyW
reviewed
Dec 12, 2024
AllyW
reviewed
Dec 19, 2024
src/azure-cli/azure/cli/command_modules/containerapp/_params.py
Outdated
Show resolved
Hide resolved
AllyW
reviewed
Dec 19, 2024
AllyW
reviewed
Dec 19, 2024
AllyW
reviewed
Dec 19, 2024
AllyW
reviewed
Dec 19, 2024
AllyW
reviewed
Dec 19, 2024
AllyW
reviewed
Dec 19, 2024
AllyW
reviewed
Dec 19, 2024
AllyW
reviewed
Dec 19, 2024
src/azure-cli/azure/cli/command_modules/containerapp/_params.py
Outdated
Show resolved
Hide resolved
AllyW
reviewed
Dec 19, 2024
src/azure-cli/azure/cli/command_modules/containerapp/_params.py
Outdated
Show resolved
Hide resolved
Co-authored-by: AllyW <AllyW@users.noreply.github.com>
kairu-ms
reviewed
Dec 20, 2024
| @@ -47,7 +47,7 @@ def _build_arguments_schema(cls, *args, **kwargs): | |||
| ) | |||
| _args_schema.search_service_name = AAZStrArg( | |||
| options=["-n", "--name", "--search-service-name"], | |||
| help="The name of the Azure Cognitive Search service to create or update. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. Search service names must be globally unique since they are part of the service URI (https://<name>.search.windows.net). You cannot change the service name after the service is created.", | |||
| help="The name of the Azure Cognitive Search service to create or update. Search service names must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 characters in length. Search service names must be globally unique since they are part of the service URI (`https://<name>.search.windows.net`). You cannot change the service name after the service is created.", | |||
There was a problem hiding this comment.
Please fix it in aaz model as well
There was a problem hiding this comment.
search service didn't upload their original aaz models into cli repo.
There was a problem hiding this comment.
We should contact the search service to provide the aaz model and fix their models.
kairu-ms
reviewed
Dec 20, 2024
...li/azure/cli/command_modules/network/aaz/latest/network/application_gateway/probe/_create.py
Show resolved
Hide resolved
kairu-ms
approved these changes
Dec 26, 2024
zhoxing-ms
approved these changes
Dec 27, 2024
calvinhzy
approved these changes
Dec 30, 2024
jsntcy
approved these changes
Jan 2, 2025
evelyn-ys
reviewed
Jan 6, 2025
| @@ -55,7 +55,7 @@ def _build_arguments_schema(cls, *args, **kwargs): | |||
| ) | |||
| _args_schema.filter = AAZStrArg( | |||
| options=["--filter"], | |||
| help="Specify $filter='Type eq <type>' to filter on user type property", | |||
| help="Specify `$filter='Type eq <type>'` to filter on user type property", | |||
There was a problem hiding this comment.
Is this change synced with aaz repo?
There was a problem hiding this comment.
Yes, aaz model has been updated in this pr: Azure/aaz#655
evelyn-ys
approved these changes
Jan 6, 2025
Greedygre
approved these changes
Jan 6, 2025
|
This PR should be backported to LTS, as |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related command
Description
Content inside
<>are interpreted as HTML tags by the reference doc generation pipeline, and doc page refuse to render those illegal html tags (please check rule detail here), which will cause our cli doc page info rendering missing.In current cli help message,
<>is widely used as placeholder tag, cmd parameter demonstrations etc.Therefore, we continued on mitigating the disallowed html tag issues in our documentation by applying the following methods:
`docker logout <registry url>`<>to{}, if option 1 is not applicable, like<key>=<value>to{key}={value}This pr is a continued effort to fix disallowed html tags in documentation, with following previous prs:
#27752
#29898
Testing Guide
History Notes
[Component Name 1] BREAKING CHANGE:
az command a: Make some customer-facing breaking change[Component Name 2]
az command b: Add some customer-facing featureThis checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.