Repository navigation
docs(site): fix stale legacy pool: syntax in quick-start examples - #2339
Draft
github-actions[bot] wants to merge 1 commit into
Draft
github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Azure Pipelines: 2 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
This branch has not been deployed
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
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.
Summary
pool:front-matter syntax in the docs-site's first-run examples with the current, recommended object form.Changes
site/src/content/docs/setup/quick-start.mdx: the "Manual" track's minimalagent.mdexample usedpool: AZS-1ES-L-MMS-ubuntu-22.04(a bare-string 1ES self-hosted pool name). Replaced withpool: vmImage: ubuntu-22.04, matching the compiler's current default for non-1ES (standalone) targets.site/src/content/docs/guides/creating-agents.mdx: the "smallest useful file" example had the same stalepool: AZS-1ES-L-MMS-ubuntu-22.04string. Replaced the same way.Accuracy checks
src/compile/codemods/0002_pool_object_form.rsconfirms bare scalarpool:strings are rewritten by a codemod into object form (name:) before compilation — the docs examples should teach the current object syntax directly rather than relying on legacy auto-rewrite behavior.src/compile/types.rs::PoolConfigdoc comment anddocs/front-matter.mdboth showvmImage: ubuntu-22.04as the Microsoft-hosted default pool form for non-1ES targets, which both edited examples now use (consistent withREADME.md's own quick-start example, which was already correct).AZS-1ES-L-MMS-ubuntu-22.04is specifically a 1ES self-hosted pool name (src/compile/common.rs::DEFAULT_ONEES_POOL), irrelevant to these plainstandalone-target examples — using it there was both stale syntax and the wrong pool for the target.Validation
cd site && npm ci && npm run build:astro— Astro build succeeds, all 38 pages generated,starlight-links-validatorreports "All internal links are valid."Created by the docs-writer workflow.
Warning
Firewall blocked 1 domain
The following domain was blocked by the firewall during workflow execution:
cdn.playwright.devTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:See Network Configuration for more information.