Corrected docs build errors for new platyps #28128
Merged
Conversation
This file contains hidden or 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
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
There was a problem hiding this comment.
Pull Request Overview
This PR fixes documentation build errors for PlatyPS by adding missing help entries and cleaning up help metadata placeholders.
- Added new cmdlet help entries for firewall policy exceptions and packet capture settings in the Network module.
- Cleared outdated placeholder values for Download Help Link and Help Version in the ImageBuilder module.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/Network/Network/help/Az.Network.md | Inserted help topics for New-AzApplicationGatewayFirewallPolicyException and New-AzPacketCaptureSettingsConfig. |
| src/ImageBuilder/ImageBuilder/help/Az.ImageBuilder.md | Removed placeholder text, leaving blank Download Help Link and Help Version fields. |
Comments suppressed due to low confidence (3)
src/ImageBuilder/ImageBuilder/help/Az.ImageBuilder.md:4
- Populate the 'Download Help Link' field with a valid URL or provide a placeholder value to ensure help metadata is complete.
Download Help Link:
src/ImageBuilder/ImageBuilder/help/Az.ImageBuilder.md:5
- Set the 'Help Version' to the module's actual version in X.X.X.X format to prevent missing metadata errors.
Help Version:
src/Network/Network/help/Az.Network.md:936
- Use 'an' before words starting with a vowel sound. Change to 'Creates an application gateway firewall policy.'
Creates a application gateway firewall policy.
YanaXu
approved these changes
Jul 4, 2025
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.
Description
Fixed content issues for new PlatyPS
Mandatory Checklist
Please choose the target release of Azure PowerShell. (⚠️ Target release is a different concept from API readiness. Please click below links for details.)
Check this box to confirm: I have read the Submitting Changes section of
CONTRIBUTING.mdand reviewed the following information:ChangeLog.mdfile(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.## Upcoming Releaseheader in the past tense.ChangeLog.mdif no new release is required, such as fixing test case only.