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

[Eng]: fill in the placeholders in help documents introduced by #18557 #19204

Open
isra-fel opened this issue Aug 11, 2022 · 4 comments
Open

[Eng]: fill in the placeholders in help documents introduced by #18557 #19204

isra-fel opened this issue Aug 11, 2022 · 4 comments
Assignees
@gdhillon24
Labels
Doc - Reference Network - Application Gateway Service Attention This issue is responsible by Azure service team.

Comments

@isra-fel
Copy link
Member

isra-fel commented Aug 11, 2022 •
edited
Loading

Description

The help documents introduced by #18557 contains placeholders which should be replaced by real cmdlet descriptions/synopsis/examples.

Here's an example of placeholder being in our online help: Add-AzApplicationGatewayBackendSetting

@gdhillon24 hi, you were the author of the PR. Could you fill in all the placeholders in the documents? Thanks.

Expected result

The help documents introduced by #18557 do not contain placeholders.
@gdhillon24
Copy link
Contributor

Acknowledged

@dingmeng-xue
Copy link
Member

@isra-fel , is this issue just talking about pull request #18557 ? or a general question? If yes, could you change the description and add expected result?

@isra-fel isra-fel changed the title [Eng]: fill in the placeholders in help documents [Eng]: fill in the placeholders in help documents introduced by #18557 Aug 18, 2022
@isra-fel
Copy link
Member Author

isra-fel commented Aug 18, 2022 •
edited
Loading

Title updated.
Expected result added.

@isra-fel isra-fel added Doc - Reference Network - Application Gateway Service Attention This issue is responsible by Azure service team. and removed Engineering labels Aug 18, 2022
@ghost
Copy link

ghost commented Aug 18, 2022

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @appgwsuppgithub.

Issue Details

Description

The help documents introduced by #18557 contains placeholders which should be replaced by real cmdlet descriptions/synopsis/examples.

Here's an example of placeholder being in our online help: Add-AzApplicationGatewayBackendSetting

@gdhillon24 hi, you were the author of the PR. Could you fill in all the placeholders in the documents? Thanks.

Expected result

The help documents introduced by #18557 do not contain placeholders.

Author: isra-fel
Assignees: gdhillon24
Labels:

Doc - Reference, Network - Application Gateway, Service Attention
Milestone: -

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gdhillon24 gdhillon24

Labels
Doc - Reference Network - Application Gateway Service Attention This issue is responsible by Azure service team.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@isra-fel @dingmeng-xue @gdhillon24