Skip to content

Migrate docs build to use PSMD2Yaml and new page template #3667

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
Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Migrate docs build to use PSMD2Yaml and new page template #3667

wants to merge 4 commits into from
+1 −1

Conversation

Saisang
Copy link
Contributor

@Saisang Saisang commented Jul 2, 2025

When MAML2Yaml is not in the path of monikerMapping.json, reference content in the docset will be built by PSMD2Yaml instead of its predecessor MAML2Yaml. For details, see https://dev.azure.com/ceapex/Engineering/_workitems/edit/783982

@Saisang Saisang requested a review from mikefrobbins as a code owner July 2, 2025 05:04
@learn-build-service-prod Learn Build Service (PROD)
Copy link
Contributor

Learn Build status updates of commit 2565221:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
azps-0.10.0/Az.Compute/Get-AzVMDiskEncryptionStatus.md ❌Error Details
azps-0.10.0/Az.Compute/New-AzAvailabilitySet.md ❌Error Details
azps-0.10.0/Az.Compute/New-AzVMSqlServerKeyVaultCredentialConfig.md ❌Error Details
azps-0.10.0/Az.Compute/Remove-AzContainerService.md ❌Error Details
azps-0.10.0/Az.Compute/Remove-AzVMBackup.md ❌Error Details
azps-0.10.0/Az.Compute/Remove-AzVMDataDisk.md ❌Error Details
azps-0.10.0/Az.Compute/Remove-AzVMNetworkInterface.md ❌Error Details
azps-0.10.0/Az.Compute/Remove-AzVmss.md ❌Error Details
azps-0.10.0/Az.Compute/Set-AzVMAccessExtension.md ❌Error Details
azps-0.10.0/Az.Compute/Set-AzVMBackupExtension.md ❌Error Details
azps-0.10.0/Az.Compute/Set-AzVMChefExtension.md ❌Error Details
azps-0.10.0/Az.Compute/Set-AzVMCustomScriptExtension.md ❌Error Details
azps-0.10.0/Az.Compute/Set-AzVMSqlServerExtension.md ❌Error Details
azps-0.10.0/Az.Network/Add-AzApplicationGatewayHttpListener.md ❌Error Details
azps-0.10.0/Az.Network/Add-AzApplicationGatewayRequestRoutingRule.md ❌Error Details
azps-0.10.0/Az.Network/Add-AzLoadBalancerInboundNatPoolConfig.md ❌Error Details
azps-0.10.0/Az.Network/Add-AzNetworkInterfaceIpConfig.md ❌Error Details
azps-0.10.0/Az.Network/Add-AzVirtualNetworkSubnetConfig.md ❌Error Details
azps-0.10.0/Az.Network/Get-AzApplicationGatewayBackendHealth.md ❌Error Details
azps-0.10.0/Az.Network/Get-AzLoadBalancer.md ❌Error Details
azps-0.10.0/Az.Network/Get-AzLoadBalancerInboundNatPoolConfig.md ❌Error Details
azps-0.10.0/Az.Network/Get-AzLocalNetworkGateway.md ❌Error Details
azps-0.10.0/Az.Network/Get-AzNetworkInterface.md ❌Error Details
azps-0.10.0/Az.Network/Get-AzNetworkSecurityGroup.md ❌Error Details
azps-0.10.0/Az.Network/Get-AzPublicIpAddress.md ❌Error Details

This comment lists only the first 25 files in the pull request.

azps-0.10.0/Az.Compute/Get-AzVMDiskEncryptionStatus.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/New-AzAvailabilitySet.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/New-AzVMSqlServerKeyVaultCredentialConfig.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/Remove-AzContainerService.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/Remove-AzVMBackup.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/Remove-AzVMDataDisk.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/Remove-AzVMNetworkInterface.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/Remove-AzVmss.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/Set-AzVMAccessExtension.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/Set-AzVMBackupExtension.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

This comment lists only the first 25 errors (including error/warning/suggestion) in the pull request.
For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

@Saisang Saisang marked this pull request as draft July 2, 2025 08:47
@learn-build-service-prod Learn Build Service (PROD)
Copy link
Contributor

Learn Build status updates of commit d7b89e8:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
azps-0.10.0/Az.Compute/Get-AzVMDiskEncryptionStatus.md ❌Error Details
azps-0.10.0/Az.Compute/New-AzAvailabilitySet.md ❌Error Details
azps-0.10.0/Az.Compute/New-AzVMSqlServerKeyVaultCredentialConfig.md ❌Error Details
azps-0.10.0/Az.Compute/Remove-AzContainerService.md ❌Error Details
azps-0.10.0/Az.Compute/Remove-AzVMBackup.md ❌Error Details
azps-0.10.0/Az.Compute/Remove-AzVMDataDisk.md ❌Error Details
azps-0.10.0/Az.Compute/Remove-AzVMNetworkInterface.md ❌Error Details
azps-0.10.0/Az.Compute/Remove-AzVmss.md ❌Error Details
azps-0.10.0/Az.Compute/Set-AzVMAccessExtension.md ❌Error Details
azps-0.10.0/Az.Compute/Set-AzVMBackupExtension.md ❌Error Details
azps-0.10.0/Az.Compute/Set-AzVMChefExtension.md ❌Error Details
azps-0.10.0/Az.Compute/Set-AzVMCustomScriptExtension.md ❌Error Details
azps-0.10.0/Az.Compute/Set-AzVMSqlServerExtension.md ❌Error Details
azps-0.10.0/Az.Network/Add-AzApplicationGatewayHttpListener.md ❌Error Details
azps-0.10.0/Az.Network/Add-AzApplicationGatewayRequestRoutingRule.md ❌Error Details
azps-0.10.0/Az.Network/Add-AzLoadBalancerInboundNatPoolConfig.md ❌Error Details
azps-0.10.0/Az.Network/Add-AzNetworkInterfaceIpConfig.md ❌Error Details
azps-0.10.0/Az.Network/Add-AzVirtualNetworkSubnetConfig.md ❌Error Details
azps-0.10.0/Az.Network/Get-AzApplicationGatewayBackendHealth.md ❌Error Details
azps-0.10.0/Az.Network/Get-AzLoadBalancer.md ❌Error Details
azps-0.10.0/Az.Network/Get-AzLoadBalancerInboundNatPoolConfig.md ❌Error Details
azps-0.10.0/Az.Network/Get-AzLocalNetworkGateway.md ❌Error Details
azps-0.10.0/Az.Network/Get-AzNetworkInterface.md ❌Error Details
azps-0.10.0/Az.Network/Get-AzNetworkSecurityGroup.md ❌Error Details
azps-0.10.0/Az.Network/Get-AzPublicIpAddress.md ❌Error Details

This comment lists only the first 25 files in the pull request.

azps-0.10.0/Az.Compute/Get-AzVMDiskEncryptionStatus.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/New-AzAvailabilitySet.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/New-AzVMSqlServerKeyVaultCredentialConfig.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/Remove-AzContainerService.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/Remove-AzVMBackup.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/Remove-AzVMDataDisk.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/Remove-AzVMNetworkInterface.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/Remove-AzVmss.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/Set-AzVMAccessExtension.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/Set-AzVMBackupExtension.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

This comment lists only the first 25 errors (including error/warning/suggestion) in the pull request.
For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

@Saisang
Copy link
Contributor Author

Saisang commented Jul 2, 2025 •
edited
Loading

@sdwheeler Could you fix the errors?

  1. "yaml-syntax-error" type error? That's because the metadata has extra "{{}}".
  2. azps-12.5.0/Az.CognitiveServices/New-AzCognitiveServicesAccountDeployment.md, Missing required attribute: 'parameters.cmdletParameters.parameterSets.position'.

And the warnings:

  1. xref-not-found, File name issue.
  2. PSMD2Yaml_InconsistentCmdletsInModule, "Inconsistent cmdlets found in module: Az.Network. 2 cmdlets in the module folder but not listed in the module file: New-AzApplicationGatewayFirewallPolicyException, New-AzPacketCaptureSettingsConfig."

The other errors/warnings would be fixed in next batch by xmdanni.

CC @xmdanni @mtrilbybassett

@sdwheeler
Copy link
Collaborator

See fixes in #3670

@learn-build-service-prod Learn Build Service (PROD)
Copy link
Contributor

Learn Build status updates of commit 49859fa:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
azps-0.10.0/Az.Compute/Get-AzVMDiskEncryptionStatus.md ❌Error Details
azps-0.10.0/Az.Compute/New-AzAvailabilitySet.md ❌Error Details
azps-0.10.0/Az.Compute/New-AzVMSqlServerKeyVaultCredentialConfig.md ❌Error Details
azps-0.10.0/Az.Compute/Remove-AzContainerService.md ❌Error Details
azps-0.10.0/Az.Compute/Remove-AzVMBackup.md ❌Error Details
azps-0.10.0/Az.Compute/Remove-AzVMDataDisk.md ❌Error Details
azps-0.10.0/Az.Compute/Remove-AzVMNetworkInterface.md ❌Error Details
azps-0.10.0/Az.Compute/Remove-AzVmss.md ❌Error Details
azps-0.10.0/Az.Compute/Set-AzVMAccessExtension.md ❌Error Details
azps-0.10.0/Az.Compute/Set-AzVMBackupExtension.md ❌Error Details
azps-0.10.0/Az.Compute/Set-AzVMChefExtension.md ❌Error Details
azps-0.10.0/Az.Compute/Set-AzVMCustomScriptExtension.md ❌Error Details
azps-0.10.0/Az.Compute/Set-AzVMSqlServerExtension.md ❌Error Details
azps-0.10.0/Az.Network/Add-AzApplicationGatewayHttpListener.md ❌Error Details
azps-0.10.0/Az.Network/Add-AzApplicationGatewayRequestRoutingRule.md ❌Error Details
azps-0.10.0/Az.Network/Add-AzLoadBalancerInboundNatPoolConfig.md ❌Error Details
azps-0.10.0/Az.Network/Add-AzNetworkInterfaceIpConfig.md ❌Error Details
azps-0.10.0/Az.Network/Add-AzVirtualNetworkSubnetConfig.md ❌Error Details
azps-0.10.0/Az.Network/Get-AzApplicationGatewayBackendHealth.md ❌Error Details
azps-0.10.0/Az.Network/Get-AzLoadBalancer.md ❌Error Details
azps-0.10.0/Az.Network/Get-AzLoadBalancerInboundNatPoolConfig.md ❌Error Details
azps-0.10.0/Az.Network/Get-AzLocalNetworkGateway.md ❌Error Details
azps-0.10.0/Az.Network/Get-AzNetworkInterface.md ❌Error Details
azps-0.10.0/Az.Network/Get-AzNetworkSecurityGroup.md ❌Error Details
azps-0.10.0/Az.Network/Get-AzPublicIpAddress.md ❌Error Details

This comment lists only the first 25 files in the pull request.

azps-0.10.0/Az.Compute/Get-AzVMDiskEncryptionStatus.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/New-AzAvailabilitySet.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/New-AzVMSqlServerKeyVaultCredentialConfig.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/Remove-AzContainerService.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/Remove-AzVMBackup.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/Remove-AzVMDataDisk.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/Remove-AzVMNetworkInterface.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/Remove-AzVmss.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/Set-AzVMAccessExtension.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

azps-0.10.0/Az.Compute/Set-AzVMBackupExtension.md

  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.
  • Line 0, Column 0: [Error: missing-attribute] Missing required attribute: 'parameters.cmdletParameters.description'.

This comment lists only the first 25 errors (including error/warning/suggestion) in the pull request.
For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

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

@sdwheeler sdwheeler Awaiting requested review from sdwheeler

@xmdanni xmdanni Awaiting requested review from xmdanni

@mtrilbybassett mtrilbybassett Awaiting requested review from mtrilbybassett

@mikefrobbins mikefrobbins Awaiting requested review from mikefrobbins mikefrobbins is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Saisang @sdwheeler