Register azps-100.0.0 moniker for AzClips PowerShell public preview - #4376
Register azps-100.0.0 moniker for AzClips PowerShell public preview#4376DanielMicrosoft wants to merge 3 commits into
Conversation
First-time onboarding of the AzClips-PowerShell docset under the `azps-100.0.0` moniker (friendly name 'Az PowerShell 0.10.0 Preview'). - mapping/monikerMapping.json: new moniker entry (packageRoot, conceptualToc, serviceMap). - mapping/az-groupMapping-100.0.0.json: service map for the 24 cmdlets AzClips ships today (grouped by module: Compute, Config, Accounts, MS Graph, Resources). First-pass categorisation; happy to align with docs.ms conventions. - docs-conceptual/azps-100.0.0/toc.yml: minimal landing TOC placeholder pending real conceptual content. Content commit follows in the next commit via build/Sync-AzclipsPowerShellDocs.ps1 in Azure/azclips.
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit 456348b: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue. This comment lists only the first 25 files in the pull request. azps-100.0.0/Az.Compute
azps-100.0.0/Az.Compute/Get-AzVM.md
azps-100.0.0/Az.Compute/New-AzVM.md
azps-100.0.0/Az.Compute/Remove-AzVM.md
azps-100.0.0/Az.Config
azps-100.0.0/Az.Config/Get-AzConfig.md
azps-100.0.0/Az.Config/Get-AzConfigInfo.md
azps-100.0.0/Az.Config/Get-AzConfigList.md
azps-100.0.0/Az.Config/Remove-AzConfig.md
azps-100.0.0/Az.Config/Set-AzConfig.md
azps-100.0.0/Az.Login
azps-100.0.0/Az.Login/Connect-AzAccount.md
azps-100.0.0/Az.Login/Disconnect-AzAccount.md
azps-100.0.0/Az.Login/Get-AzProfile.md
azps-100.0.0/Az.Login/Remove-AzProfile.md
azps-100.0.0/Az.Login/Set-AzProfile.md
azps-100.0.0/Az.MsGraph
azps-100.0.0/Az.MsGraph/Get-AzMsGraphApplication.md
azps-100.0.0/Az.MsGraph/Get-AzMsGraphGroup.md
azps-100.0.0/Az.MsGraph/Get-AzMsGraphGroupMember.md
azps-100.0.0/Az.MsGraph/Get-AzMsGraphUser.md
azps-100.0.0/Az.MsGraph/New-AzMsGraphApplication.md
azps-100.0.0/Az.MsGraph/Remove-AzMsGraphApplication.md
azps-100.0.0/Az.Resources
azps-100.0.0/Az.Resources/Get-AzResourceGroup.md
This comment lists only the first 25 errors (including error/warning/suggestion) in the pull request. 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. |
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit cb0447a: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue. This comment lists only the first 25 files in the pull request. azps-100.0.0/Az.Compute
azps-100.0.0/Az.Compute/Get-AzVM.md
azps-100.0.0/Az.Compute/New-AzVM.md
azps-100.0.0/Az.Compute/Remove-AzVM.md
azps-100.0.0/Az.Config/Get-AzConfig.md
azps-100.0.0/Az.Config/Get-AzConfigInfo.md
azps-100.0.0/Az.Config/Get-AzConfigList.md
azps-100.0.0/Az.Config/Remove-AzConfig.md
azps-100.0.0/Az.Login
azps-100.0.0/Az.Login/Connect-AzAccount.md
azps-100.0.0/Az.Login/Disconnect-AzAccount.md
azps-100.0.0/Az.Login/Get-AzProfile.md
azps-100.0.0/Az.Login/Remove-AzProfile.md
azps-100.0.0/Az.Login/Set-AzProfile.md
azps-100.0.0/Az.MsGraph
azps-100.0.0/Az.MsGraph/Get-AzMsGraphApplication.md
azps-100.0.0/Az.MsGraph/Get-AzMsGraphGroup.md
azps-100.0.0/Az.MsGraph/Get-AzMsGraphGroupMember.md
azps-100.0.0/Az.MsGraph/Get-AzMsGraphUser.md
azps-100.0.0/Az.MsGraph/New-AzMsGraphApplication.md
azps-100.0.0/Az.MsGraph/Remove-AzMsGraphApplication.md
azps-100.0.0/Az.Resources
azps-100.0.0/Az.Resources/Get-AzResourceGroup.md
azps-100.0.0/Az.Resources/Invoke-AzRestMethod.md
azps-100.0.0/Az.Resources/New-AzResourceGroup.md
This comment lists only the first 25 errors (including error/warning/suggestion) in the pull request. 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. |
cb0447a to
98f05c7
Compare
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit 98f05c7:
|
…e, feedback_system docs.ms Learn build succeeded for azps-100.0.0 content but produced no preview URLs (`Publish Files` empty, `% Files Skipped Publishing: 100.000%`). Comparing with MicrosoftDocs/azure-docs-cli#6158 (which does emit preview URLs) surfaced that `docfx.json` needed per-moniker entries the same way `mapping/monikerMapping.json` did. Mirrors the azps-16.3.0 shape (three content entries + one resource + versions dest + ms.date + feedback_system).
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit e700b5a:
|
Onboards the AzClips PowerShell public preview under the
azps-100.0.0moniker (friendly name: Az PowerShell 0.10.0 Preview). Version100.0.0sorts above every real Az PS release on the dropdown; the "Preview" label distinguishes it.Two commits
c2dd189a9— moniker registration (config-only, hand-authored)456348b6f— first content drop (script-driven, see below)1. Registration commit —
c2dd189a9mapping/monikerMapping.jsonazps-100.0.0entry —packageRoot,conceptualToc,serviceMap. Mirrors the shape of every other moniker in the file.mapping/az-groupMapping-100.0.0.jsonCompute,Config,Accounts,MS Graph,Resources) — happy to align with docs.ms conventions if there's a preferred taxonomy.docs-conceptual/azps-100.0.0/toc.yml2. Content commit —
456348b6fProduced by the AzClips PS docs sync shim (Azure/azclips#721). Exact invocation from the AzClips repo root:
Config file the shim reads (
build/ps-docs-sync.config.json):{ "moniker": "azps-100.0.0", "targetRepoPath": "../azure-docs-powershell", "targetModuleNamePattern": "Az.{ModuleName}", "sourcePsRoot": "src/PS", "sourceRepoUrl": "https://github.com/Azure/azclips", "sourceBranch": "main", "downloadHelpLinkBase": "https://learn.microsoft.com/powershell/module" }What the shim does:
src/PS/(any module with both<Name>.psd1and a non-emptyhelp/directory).Az.<Module>.mdmodule-index files at sync time from the module manifest + each cmdlet's## SYNOPSIS.src/PS/<Module>/help/*.md(PlatyPS2024-05-01schema) intoazps-100.0.0/Az.<Module>/.Content shape
29 files across 5 modules:
azps-100.0.0/Az.Compute/Get-AzVM,New-AzVM,Remove-AzVM)azps-100.0.0/Az.Config/Get-AzConfig,Get-AzConfigInfo,Get-AzConfigList,Remove-AzConfig,Set-AzConfig)Az.Configas a distinct module. In real Az PS these live underAz.Accounts; happy to remap if that's preferred.azps-100.0.0/Az.Login/Connect-AzAccount,Disconnect-AzAccount,Get-AzProfile,Remove-AzProfile,Set-AzProfile)Az.Login; real Az PS usesAz.Accounts.azps-100.0.0/Az.MsGraph/Get-AzMsGraphApplication,Get-AzMsGraphGroup,Get-AzMsGraphGroupMember,Get-AzMsGraphUser,New-AzMsGraphApplication,Remove-AzMsGraphApplication)azps-100.0.0/Az.Resources/Get-AzResourceGroup,Invoke-AzRestMethod,New-AzResourceGroup,New-AzResourceGroupDeployment,New-AzResourceGroupDeploymentWhatIf)Plus one
Az.<Module>.mdmodule-index page per folder (5 total).Open questions for reviewers
Az.Compute/Az.Config/Az.Login/Az.MsGraph/Az.Resourcesbecause those are the AzClips module names. If docs.ms expects the classic Az PS layout (Az.Accountsfor everything Accounts/Config/Login-related), we can remap the shim'stargetModuleNamePatternand re-sync.az-groupMapping-100.0.0.json— first-pass is by-module. Guidance welcome if there's a preferred vocabulary (e.g., "Virtual Machines" instead of "Compute").docs-conceptual/azps-100.0.0/toc.ymlis a stub; we don't have onboarding-narrative markdown yet. Is a stub TOC acceptable to unblock the reference-content build, or do we need at least a landingindex.yml?PSMD2YamlvsMAML2Yaml— the docset currently usesMAML2Yaml(per.openpublishing.publish.config.json). Per the docs.ms guidance the AzClips team has seen, new onboardings targetPSMD2Yaml(PlatyPS2024-05-01-compatible). Should this PR flip the docset config, or is that a separate change docs.ms owns?Related