Skip to content

Corrected docs build errors for new platyps #28128

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

Merged
merged 1 commit into from
Jul 4, 2025

Conversation

mikefrobbins
Copy link
Contributor

Description

Fixed content issues for new PlatyPS

Mandatory Checklist

  • SHOULD update ChangeLog.md file(s) appropriately
    • Update src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.
      • A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense.
    • Should not change ChangeLog.md if no new release is required, such as fixing test case only.
  • SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
  • SHOULD have proper test coverage for changes in pull request.
  • SHOULD NOT adjust version of module manually in pull request

@Copilot Copilot AI review requested due to automatic review settings July 3, 2025 19:51
Copy link

Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status.

@mikefrobbins mikefrobbins requested a review from sdwheeler July 3, 2025 19:51
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

@sdwheeler sdwheeler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@YanaXu YanaXu merged commit 7060933 into Azure:main Jul 4, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants