Fix misdirected ESC Automation API links, add Java support, cross-link narrative pages - #20635
Fix misdirected ESC Automation API links, add Java support, cross-link narrative pages#20635workprentice[bot] wants to merge 3 commits into
Conversation
…k narrative pages Fixes #20634
Pre-merge Review — Last updated 2026-08-01T15:15:59ZTip Summary: This is a docs PR that repoints two "Automation API" links on the ESC Environments concept page from the general IaC Automation API page to the ESC-specific Review confidence:
Investigation log
🔍 Verification trail28 claims extracted · 28 verified · 0 unverifiable · 0 contradicted
🚨 Outstanding in this PRNo outstanding findings in this PR.
|
|
Your site preview for commit c3a3302 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-20635-c3a33027.s3-website.us-west-2.amazonaws.com Changed pages: |
|
🤖 Automatic review refresh errored; the review is still marked stale. Mention @claude #update-review to refresh it. |
|
🤖 Review updated on @workprentice[bot]'s request. |
Problem
content/docs/esc/concepts/environments.mdlinked to/docs/iac/concepts/automation-api/when telling readers how Automation API manages astack's imported ESC environments, but that page has no ESC-environment coverage at
all. The actual
addEnvironments/listEnvironments/removeEnvironmentdocumentationand per-language examples live at
/docs/esc/integrations/automation-api/. Separately,that integration page's language-support matrix omitted Java, and none of the narrative
Automation API pages cross-linked to it.
Changes
content/docs/esc/concepts/environments.md: both Automation API references now pointat
/docs/esc/integrations/automation-api/instead of the general concepts page.content/docs/esc/integrations/automation-api.md: added Java to the chooser and thesupported-languages sentence, with a new Java example (verified against the
com.pulumi.automation.WorkspaceStack/LocalWorkspacereference docs —addEnvironments(Collection<String>)and
removeEnvironment(String)exist; there is no list method, matching the .NETSDK's gap, which the page already calls out for C#).
content/docs/iac/concepts/automation-api.md,content/docs/iac/guides/building-extending/automation-api.md,content/docs/iac/guides/building-extending/automation-api-advanced.md: each gained ashort (2–3 sentence) cross-reference pointing readers to the ESC integration page from
the natural place in their existing narrative (the
Stack/RemoteStacksection, the"Associate with a stack" section, and the workspace-lifecycle section, respectively).
No examples were duplicated.
The Java code example was verified against the live API reference at
docs/reference/pkg/java/com/pulumi/automation/{WorkspaceStack,LocalWorkspace}.html(method signatures for
addEnvironments,removeEnvironment, and the inline-programoverload of
createOrSelectStack) rather than compiled, since no Maven/JDK toolchain isavailable in this environment; the surrounding prose and chooser tag follow the exact
pattern already used for Java elsewhere in this same guide
(
content/docs/iac/guides/building-extending/automation-api.md's "Associate with astack" section), so the shortcode usage is consistent with existing conventions.
Supporting signal
GA4 (28-day window) shows
/docs/iac/concepts/automation-api/— the misdirected linktarget — has a below-average engagement rate for its traffic volume, consistent with
readers arriving expecting ESC coverage, not finding it, and leaving quickly.
Fixes #20634.
🧠 This PR was created by workprentice on behalf of the Docs Groundskeeper automation, running its scheduled freshness-audit backlog cycle.