Skip to content

Add Neo CLI integrations documentation#18846

Draft
foot wants to merge 1 commit into
masterfrom
foot/cli-integration-docs
Draft

Add Neo CLI integrations documentation#18846
foot wants to merge 1 commit into
masterfrom
foot/cli-integration-docs

Conversation

@foot
Copy link
Copy Markdown
Contributor

@foot foot commented May 8, 2026

Summary

Adds documentation for Neo CLI integrations, fast-following the MCP integrations feature.

  • New page /docs/ai/integrations/cli/ covering:

    • What CLI integrations are vs. MCP integrations
    • The four supported CLIs (aws, gcp, azure, kubectl) and their required env vars
    • Recommended ESC credential setup, with the Login Provider Setup wizard surfaced as the easiest path for AWS/GCP/Azure (linking the ESC onboarding blog post since there's no formal docs page yet) and the pulumi-stacksfiles.KUBECONFIG pattern recommended for Kubernetes
    • Connect / disconnect flow against the actual UI (verified against the cmd/console2 components — labels match: CLI tools section, Name + ESC environment picker, Manage integrationDisconnect integration)
    • Per-task selection — covers the in-flight pulumi/pulumi-service#42759
    • Auditing and troubleshooting
  • Light parent-page reframe at /docs/ai/integrations/: introduces the two kinds of integration (MCP and CLI) and cross-links to the new page. Existing MCP-specific sections are now correctly scoped under "MCP integrations".

Follow-ups (not in this PR)

  • The Login Provider Setup wizard has no formal /docs/esc/ page yet; only the October 2025 ESC onboarding blog post covers it. Worth a real ESC-team docs follow-up so we can re-point this page.
  • The page documents per-task CLI integration selection in anticipation of pulumi/pulumi-service#42759 landing. If anything in that PR shifts (label, location), this page will need a small follow-up edit.

Test plan

  • Hugo build passes (CI)
  • Markdown lint passes (CI; pre-commit lint already passed locally)
  • Spot-check rendered page in a preview deploy: anchors (#recommended-credential-setup, #2-connect-the-integration-in-neo), tip admonition, and cross-links to ESC docs all resolve

🤖 Generated with Claude Code

Adds /docs/ai/integrations/cli/ covering the new Neo CLI integrations
feature — what they are vs. MCP integrations, supported CLIs (aws, gcp,
azure, kubectl), recommended ESC credential setup (with an emphasis on
the Login Provider Setup wizard for AWS/GCP/Azure and the
pulumi-stacks → kubeconfig pattern for Kubernetes), connect/disconnect
flow, per-task selection, and troubleshooting.

Lightly reframes the parent /docs/ai/integrations/ page to introduce
the two kinds of integration (MCP and CLI) and link across.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented May 8, 2026

Docs review

Solid PR — the new page is well-structured, the parent reframe lands cleanly, and the verifiable details check out. I confirmed:

  • All six cross-doc links resolve (aws-login, gcp-login, azure-login, configuring-oidc/{aws,gcp,azure}, kubernetes/kubernetes, pulumi-iac/pulumi-stacks).
  • All three intra-page anchors match Hugo's slugified headings (#recommended-credential-setup, #2-connect-the-integration-in-neo, #per-task-selection).
  • Frontmatter is complete on both files; meta descriptions stay ≤160 chars.
  • Heading case (Title Case H1, sentence case H2+), ordered-list 1. convention, and {{% notes type=\"tip\" %}} usage all match repo patterns.

Issue: + 'STYLE-GUIDE.md' +disallows "easy/simple" — flag at + 'content/docs/ai/integrations/cli/_index.md:48' +

The H4 "Easiest path: Login Provider Setup wizard (AWS, GCP, Azure)" uses the superlative of "easy", which the style guide explicitly avoids ("These judge difficulty and may alienate readers"). The accompanying tip block already calls this "Recommended for first-time setup," so the heading can lean on framing other than difficulty.

A couple of options:

+ '```suggestion' +

Wizard setup: Login Provider Setup (AWS, GCP, Azure)

+ '```' +

or, if you want to keep the path/manual contrast:

+ '```suggestion' +

Automated setup: Login Provider Setup wizard (AWS, GCP, Azure)

+ '```' +

Suggestion (optional): Heading nesting at + 'content/docs/ai/integrations/cli/_index.md:44' +

"Recommended credential setup" is an H3 nested inside H2 "Supported CLIs". It reads naturally in body order (you list the CLIs, then explain how to credential them), but in the rendered TOC a reader may expect setup guidance to be a peer of "Setting up a CLI integration" (H2 at line 73) rather than a child of the table section. Promoting it to H2 would also flatten the H4 sub-sections to H3, which is a more conventional depth. Non-blocking; only worth changing if you agree.

Nit: light repetition at + 'content/docs/ai/integrations/cli/_index.md:46-54' +

"Login Provider Setup" / "Login Provider Setup wizard" appears in the lead-in sentence (line 46), the H4 (line 48), and the tip body (line 51). One of those references could be trimmed — for example, the lead-in could say "...the wizard does the work for you..." since the H4 right below it names the wizard. Optional polish.

Publishing readiness

  • Frontmatter (title, title_tag, h1, meta_desc, meta_image, menu) complete on the new page.
  • Internal links resolve.
  • Anchor links resolve.
  • Code block has language specifier ( + 'bash' + ).
  • No images in this PR (alt-text check N/A).
  • Parent page meta_desc updated to reflect the new scope.

If you want another pass after addressing the heading, mention me (@claude) and I'll take another look.

@pulumi-bot
Copy link
Copy Markdown
Collaborator

@foot foot changed the title Add CLI integrations documentation Add Neo CLI integrations documentation May 8, 2026
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.

2 participants