Skip to content

docs(idp): add copyable Deploy with Pulumi button snippet#20086

Open
joeduffy wants to merge 2 commits into
masterfrom
fix_issue_12057_pulumi_button_snippet
Open

docs(idp): add copyable Deploy with Pulumi button snippet#20086
joeduffy wants to merge 2 commits into
masterfrom
fix_issue_12057_pulumi_button_snippet

Conversation

@joeduffy

@joeduffy joeduffy commented Jul 5, 2026

Copy link
Copy Markdown
Member

What

Adds a ready-to-copy Markdown snippet directly beneath the intro "Deploy with Pulumi" button example, so a reader can grab the exact source for that button without right-clicking the rendered image to find its URL. It also fixes the existing "Creating a Pulumi Button" example snippets, which used relative image paths (/images/deploy-with-pulumi/dark.svg) that only resolve on pulumi.com — once copied into a README hosted elsewhere, the button image renders broken. Those snippets now use the fully qualified https://www.pulumi.com/... URL, matching the pattern already used correctly in the "Button Image" reference list further down the page.

Why

Fixes #12057. The reporter noted that producing a button snippet required right-clicking the rendered button to recover its image URL and hand-crafting the Markdown link, a step that's easy to get wrong. This change surfaces the snippet directly, and closes a related gap where even the page's existing example snippets would have broken once copied outside pulumi.com.

Verification

  • Confirmed both the button SVG URL and the app.pulumi.com/new?template=... target URL return 200.
  • Verified the YAML front matter still parses and all fenced code blocks remain balanced.
  • Reviewed the rendered diff for correctness; no other content on the page was touched.

🧠 This PR was created by workprentice on behalf of @joeduffy.

Add a ready-to-copy Markdown snippet directly beneath the intro example
button so users no longer have to right-click the image to find its URL
and hand-craft the Markdown link themselves.

Also switch the existing Markdown/HTML examples in "Creating a Pulumi
Button" from relative image paths to fully qualified pulumi.com URLs,
since a relative path only resolves on pulumi.com and renders as a
broken image once pasted into a README hosted elsewhere.

Fixes #12057
@github-actions github-actions Bot added review:triaging Claude Triage is currently classifying the PR domain:docs PR touches technical docs review:in-progress Claude review is currently running and removed review:triaging Claude Triage is currently classifying the PR labels Jul 5, 2026
@github-actions

github-actions Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Pre-merge Review — Last updated 2026-07-05T14:24:34Z

Tip

Summary: This is a small docs change to the IDP "Deploy with Pulumi button" integration page (content/docs/idp/integrations/pulumi-button.md). It adds a copyable Markdown snippet next to the intro button example and switches the button image references in the "Creating a Pulumi Button" section from relative paths (/images/...) to the fully qualified URL (https://www.pulumi.com/images/deploy-with-pulumi/dark.svg), with a sentence explaining why — a relative path only resolves on pulumi.com and breaks when pasted into an external README. The main way this could mislead a reader would be a dead image URL or a broken cross-reference anchor; both check out — the cited image URL returns HTTP 200 and the #creating-a-pulumi-button link resolves to the existing section on the page. Fact-check, cited-claim spot-checks, frontmatter, and code-example passes all ran clean; no build or link-integrity issues surfaced. A follow-up commit (3bae273) dropped the redundant "as shown above" directional reference flagged in the previous pass.

Review confidence:

Dimension Level Notes
mechanics HIGH
facts HIGH
code correctness HIGH
Investigation log
  • Cross-sibling reads: not run (not in a templated section)
  • External claim verification: 7 of 8 claims verified (0 unverifiable, 0 contradicted) · 4 specialists (numerical, cross-reference, capability, framing); 0 cross-specialist corroborations · routed: 0 inline, 5 Pass 1, 3 Pass 2 (verified 3, contradicted 0, unverifiable 0), 0 Pass 3.
  • Cited-claim spot-checks: 3 of 3 cited claims fetched and compared
  • Frontmatter sweep: ran on body + meta_desc
  • Temporal-trigger sweep: ran (recency words present in diff; spot-check in-review)
  • Code execution: not run (no static/programs/ change)
  • Code-examples checks: ran (3 specialists: structural, existence, body-code-coverage); 0 findings
  • Editorial-balance pass: not run (not under content/blog/)
🚨 Outstanding ⚠️ Low-confidence 💡 Pre-existing ✅ Resolved
0 0 0 0

🔍 Verification trail

8 claims extracted · 7 verified · 0 unverifiable · 0 contradicted
  • L29 in content/docs/idp/integrations/pulumi-button.md "The Markdown snippet for the Pulumi Deploy button uses the fully qualified image URL https://www.pulumi.com/images/deploy-with-pulumi/dark.svg rather than a re…" (also L31-33, L35) → ✅ verified (evidence: The cited URL https://www.pulumi.com/images/deploy-with-pulumi/dark.svg returns HTTP 200, confirming this fully qualified image URL exists and is a valid, reachable resource rather than a broken/relative reference.; source: https://www.pulumi.com/images/deploy-with-pulumi/dark.svg)
  • L29 in content/docs/idp/integrations/pulumi-button.md "Right-clicking the Pulumi Deploy button image will not correctly recover its image URL for reuse in a README, gist, or blog post; the Markdown snippet must be…" → ➖ not-a-claim (evidence: The line is the PR author's own instructional rationale embedded in the doc ("Rather than right-clicking the button to recover its image URL, copy the Markdown snippet below..."), not a third-party-attributed or externally falsifiable tech…; source: repo:content/docs/idp/integrations/pulumi-button.md)
  • L35 in content/docs/idp/integrations/pulumi-button.md "The template query parameter in the Pulumi Deploy button URL can be swapped for the URL of a different project template to point the button at a different re…" → ✅ verified (evidence: The doc itself states: "Swap the template query parameter for the URL of your own project template to point the button at your repository instead," and later shows examples of changing the template URL to different repos (e.g. pulumi/exa…; source: repo:content/docs/idp/integrations/pulumi-button.md)
  • L35 in content/docs/idp/integrations/pulumi-button.md "The 'Creating a Pulumi Button' section below (linked via #creating-a-pulumi-button) contains the full Markdown and HTML forms of the button snippet, plus the c…" → ✅ verified (evidence: The "## Creating a Pulumi Button" section contains a Markdown code block, "Or, the equivalent HTML:" code block, and a "### Button Image" subsection listing dark/light SVG and PNG variants — matching the claim exactly.; source: repo:content/docs/idp/integrations/pulumi-button.md)
  • L77 in content/docs/idp/integrations/pulumi-button.md "The Pulumi Deploy button's image src/href must use the fully qualified URL https://www.pulumi.com/images/deploy-with-pulumi/dark.svg rather than a relative pat…" (also L84, L88) → ✅ verified (evidence: The cited URL https://www.pulumi.com/images/deploy-with-pulumi/dark.svg returns HTTP 200, confirming the image asset exists at that fully qualified path and can be used as the button's src/href. The claim about requiring a fully-qualified…; source: https://www.pulumi.com/images/deploy-with-pulumi/dark.svg)
  • L84 in content/docs/idp/integrations/pulumi-button.md "The HTML equivalent of the Deploy with Pulumi button uses an tag with src set to https://www.pulumi.com/images/deploy-with-pulumi/dark.svg." → ✅ verified (evidence: The cited URL https://www.pulumi.com/images/deploy-with-pulumi/dark.svg returns HTTP 200, confirming the image asset exists at that path as referenced for the button's img src; body content (SVG binary) is not text-inspectable but the reso…; source: https://www.pulumi.com/images/deploy-with-pulumi/dark.svg)
  • L88 in content/docs/idp/integrations/pulumi-button.md "A relative image path for the Deploy with Pulumi button renders as a broken image once the Markdown snippet is pasted into a README hosted elsewhere (outside p…" → ✅ verified (evidence: The doc itself states: "Use the fully qualified image URL rather than a relative path — a relative path only resolves on pulumi.com and renders as a broken image once the snippet is pasted into a README hosted elsewhere."; source: repo:content/docs/idp/integrations/pulumi-button.md)
  • L92 in content/docs/idp/integrations/pulumi-button.md "Pulumi provides both SVG and PNG versions of the Deploy button image, each available in both light and dark themes, at specific URLs." → ✅ verified (evidence: The same doc lists exact URLs: "Pulumi provides both SVG and PNG versions of the button image at the following URLs in both light and dark themes" followed by dark.svg, dark.png, light.svg, light.png URLs.; source: repo:content/docs/idp/integrations/pulumi-button.md)

🚨 Outstanding in this PR

No outstanding findings in this PR.

⚠️ Low-confidence

Review each and resolve as appropriate — these don't block the PR.

No low-confidence findings in this PR.

💡 Pre-existing issues in touched files (optional)

No pre-existing issues in touched files.

✅ Resolved since last review

No items resolved since the last review.

📜 Review history

  • 2026-07-05T14:15:30Z — No blockers; verified the copyable snippet's image URL (HTTP 200) and the #creating-a-pulumi-button anchor; one style nag on an "as shown above" directional reference (54a512d)
  • 2026-07-05T14:24:34Z — re-reviewed after fix push (1 new commit, 3bae273); the flagged directional reference was removed, no recurrence found elsewhere in the file, no new findings introduced

Need a re-review? Want to dispute a finding? Mention @claude and include #update-review.
(For ad-hoc questions or fixes, just @claude — no hashtag.)

@github-actions github-actions Bot added review:no-blockers Claude review completed cleanly; outstanding is empty and removed review:in-progress Claude review is currently running labels Jul 5, 2026
@joeduffy

joeduffy commented Jul 5, 2026

Copy link
Copy Markdown
Member Author

@claude #update-review

@github-actions github-actions Bot added review:stale New commits since last Claude review; refresh on next ready-transition or @claude mention review:in-progress Claude review is currently running and removed review:no-blockers Claude review completed cleanly; outstanding is empty review:stale New commits since last Claude review; refresh on next ready-transition or @claude mention labels Jul 5, 2026
@pulumi-bot

pulumi-bot commented Jul 5, 2026

Copy link
Copy Markdown
Collaborator

@github-actions

github-actions Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

🤖 Review updated on @joeduffy's request.

@github-actions github-actions Bot added review:no-blockers Claude review completed cleanly; outstanding is empty and removed review:in-progress Claude review is currently running labels Jul 5, 2026

@CamSoper CamSoper left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated rubber stamp approval applied :shipit:


Generated by Claude Code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain:docs PR touches technical docs review:no-blockers Claude review completed cleanly; outstanding is empty

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a copyable snippet to the Deploy with Pulumi button page

4 participants