Skip to content

docs(site): fix stale legacy pool: syntax in quick-start examples - #2339

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-stale-legacy-pool-syntax-quickstart-52fb0be93ba94f7f
Draft

github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-stale-legacy-pool-syntax-quickstart-52fb0be93ba94f7f

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Summary

  • Replaced stale legacy scalar 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 minimal agent.md example used pool: AZS-1ES-L-MMS-ubuntu-22.04 (a bare-string 1ES self-hosted pool name). Replaced with pool: 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 stale pool: AZS-1ES-L-MMS-ubuntu-22.04 string. Replaced the same way.

Accuracy checks

  • src/compile/codemods/0002_pool_object_form.rs confirms bare scalar pool: 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::PoolConfig doc comment and docs/front-matter.md both show vmImage: ubuntu-22.04 as the Microsoft-hosted default pool form for non-1ES targets, which both edited examples now use (consistent with README.md's own quick-start example, which was already correct).
  • AZS-1ES-L-MMS-ubuntu-22.04 is specifically a 1ES self-hosted pool name (src/compile/common.rs::DEFAULT_ONEES_POOL), irrelevant to these plain standalone-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-validator reports "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.dev

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "cdn.playwright.dev"

See Network Configuration for more information.

Generated by Docs Writer · auto · 96.5 AIC · ⌖ 6.74 AIC · ⊞ 11.9K · ◷

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@azure-pipelines

Copy link
Copy Markdown
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

No deployments
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.

0 participants