Register azure-cli-preview moniker for AzClips public preview - #6153
DanielMicrosoft wants to merge 4 commits into
Conversation
Adds the azure-cli-preview moniker to the docset config so content published under docs-ref-autogen/preview-version/latest can be built and rendered on Learn. The moniker itself is already registered in the docs.ms central store (Platform: bash, Family: Azure CLI, Product: Preview) with Live=false and Prerelease=true; it will remain hidden from the dropdown until content is staged and we request Live=true. Includes a minimal placeholder TOC.yml under docs-ref-autogen/preview-version/latest/ so docfx does not fail on the missing src folder. Actual content will land via subsequent PRs from the AzClips sync pipeline. Follows the folder-naming convention used by Latest-version/latest and LTS-version/latest per docs.ms guidance.
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 bdde714:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| Details | |||
| .openpublishing.publish.config.json | ✅Succeeded | ||
| docfx.json | ✅Succeeded | ||
| docs-ref-autogen/preview-version/latest/TOC.yml | ✅Succeeded |
- Line 0, Column 0: [Warning: redirected-file-not-removed - See documentation]
Redirected file 'docs-ref-autogen/Latest-version/latest/service-page/Azure Front Door.yml' are still in the repo. After adding a file to the redirection JSON file, you must delete the original file from the repo. - Line 0, Column 0: [Warning: redirected-file-not-removed - See documentation]
Redirected file 'docs-ref-autogen/Latest-version/latest/service-page/Azure Migrate.yml' are still in the repo. After adding a file to the redirection JSON file, you must delete the original file from the repo. - Line 0, Column 0: [Warning: publish-url-conflict]
Two or more files publish to the same url '/cli/azure/command/toc.json': 'docs-ref-autogen/LTS-version/2017-03-09-profile/TOC.yml', 'docs-ref-autogen/LTS-version/2018-03-01-hybrid/TOC.yml', 'docs-ref-autogen/LTS-version/2019-03-01-hybrid/TOC.yml', 'docs-ref-autogen/LTS-version/2020-09-01-hybrid/TOC.yml', 'docs-ref-autogen/LTS-version/latest/TOC.yml'....
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.
Runs AzClips's cli-export → CLI2Yaml 20260827.1.0 → SDP YAML pipeline against the current tip of Azure/azclips main, producing 20 reference files covering agent, config, deployment, disk, extension, group, identity, msgraph, profile, and vm verbs (plus TOC, reference-index, service-page). editLink values point at github.com/Azure/azclips/blob/main/… via the --sourceRepo and --editBranch options landed in CLI2Yaml PR 1213094. Content is a snapshot for review preview only; production content will be pushed by a subsequent AzClips sync pipeline. Moniker remains Live=false in the central store, so this content is invisible to customers until we request the flip.
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 c5bee8e:
|
Adds the missing azure-cli-preview entries to the 'groups' and 'versions' maps in docfx.json. Without these, the build system did not emit a ?view=azure-cli-preview parameter on preview-version URLs, causing 10 publish-url-conflict warnings against Latest/LTS files (e.g. both docs-ref-autogen/preview-version/latest/vm.yml and docs-ref-autogen/Latest-version/latest/vm.yml were claiming /cli/azure/vm). After this change, preview-version pages should publish to /cli/azure/<cmd>?view=azure-cli-preview, in line with the other monikers already registered.
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 1767a77:
|
The single preview-version/latest/service-page/azure-cli.yml page was emitting bare command names (agent, config, vm, ...) instead of az_-prefixed xrefs, producing 11 xref-not-found warnings against non-existent uids. It also only covered a catch-all 'azure-cli' service rather than the ~200 per-Azure-service pages that Latest/LTS carry. Removing it eliminates the warnings without any user-visible loss (reference-index and command TOC still render normally). Proper service-page generation will be re-enabled once the upstream azclips-side inputs (service_name.json + CLI2Yaml xref formatting) are fixed. Tracked in Azure/CLIPS as a follow-up sub-issue of MicrosoftDocs#588.
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 |
1 participant
Registers the �zure-cli-preview moniker in the docset config, populates
docs-ref-autogen/preview-version/latest/with an initial snapshot of AzClips CLI reference content so the moniker is renderable on the docs.ms preview build.Context
Part of onboarding the upcoming public preview of the next-generation Azure CLI (product-visible label
Azure CLI 100.0.0 (Public Preview)). Paired with a matching moniker request againstMicrosoftDocs/azure-docs-powershellfor the PowerShell side.Moniker central-store state
The moniker itself is already registered in the docs.ms central moniker store with:
bash/ FamilyAzure CLI/ ProductPreviewazure-cli-previewAzure CLI 100.0.0 (Public Preview)Livefalse(keeps the moniker off the version dropdown until content is ready)Prereleasetrue(excluded from default routing)Order1(bottom placement per opt-in positioning)We will request a
Live=trueflip once the docs.ms build validates the shape. No customer-visible change at merge time.Changes
.openpublishing.publish.config.json— append"azure-cli-preview"tomoniker_ranges.docfx.json— add twogroup/srcroute entries mirroring theazure-cli-latestpattern, pointing atdocs-ref-autogen/preview-version/latest.docs-ref-autogen/preview-version/latest/**— 20 SDP YAML files (initial AzClips CLI reference snapshot). Coversagent,config,deployment,disk,extension,group,identity,msgraph,profile, andvmverbs plusTOC.yml,reference-index.yml, andservice-page/azure-cli.yml.How the content was generated
Ran AzClips's
Azclips.Cli.Export(produces snake_case JSON per top-level verb) →CLI2Yaml 20260827.1.0(SDP YAML transformer, prod feed) against the current tip ofAzure/azclips:main. Command:dotnet CLI2Yaml.dll -c <cli-export-output> -e <empty> -o docs-ref-autogen/preview-version --config .docsreference.azclips.json --commitMap doc_commit_map.json --extensionIndex index.json --serviceMapping service_name.json --sourceRepo https://github.com/Azure/azclips --editBranch main--sourceRepoand--editBranchare the options landed in CLI2Yaml PR 1213094, which route every command'seditLinkatgithub.com/Azure/azclips/blob/main/…instead of the default azure-cli.Once the AzClips sync pipeline is wired for production (in-flight), this content will refresh automatically on release cadence — matching how
azclibotrefreshesLatest-version/latest/today.Naming rationale
Folder path
docs-ref-autogen/preview-version/latest/follows the convention used byLatest-version/latest/andLTS-version/latest/per docs.ms guidance. Outer folder is a version-channel label; innerlatestmatches the CLI2Yaml internal moniker.The URL slug
azure-cli-previewis channel-shaped (matches the pattern ofazure-cli-latestandazure-cli-lts); version numbers live in the friendly name only and roll forward in place as preview releases ship (100.0.0→100.1.0→ ...).Follow-up (not in this PR)
docs-ref-conceptual/— added once conceptual content is ready to migrate.JoinTOCPluginentry — added alongside the conceptual routes.Happy to iterate on any of the above — this is a Draft PR.