docs: rename pulumi cloud api to pulumi api#18887
Conversation
Update custom docs and the LLM agent index to reflect the breaking CLI rename from `pulumi cloud api` to top-level `pulumi api`. Move the CLI guide `cloud-api.md` to `api.md` with an alias for SEO. Custom doc references now point to the future `/docs/iac/cli/commands/pulumi_api*/` URLs, which become valid once the auto-generated CLI command docs land upstream. Auto-generated command docs in `content/docs/iac/cli/commands/` are intentionally untouched — they'll be replaced by the next regen run. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Docs review for #18887Reviewed the rename of What looks good
Issues / suggestions1. Page `title` no longer matches the URL/command — `content/docs/iac/cli/api.md` line 2 The frontmatter still reads `title: Calling the Cloud API`, but the URL is now `/docs/iac/cli/api/`, the command is `pulumi api`, the `h1` is "Calling the Pulumi Cloud REST API from the CLI", and the `title_tag` is "Pulumi CLI: Calling the Pulumi Cloud REST API". The nav title is the odd one out — "Calling the Cloud API" is ambiguous (Automation API? Cloud REST API?) and inconsistent with how the page now reads. Recommend aligning it with the h1/title_tag for clarity. ```suggestion 2. OpenAPI cache directory path may be stale — `content/docs/iac/cli/api.md` line 79 The doc says the CLI caches the spec under `$PULUMI_HOME/cloud-api-cache//spec.json`. If the upstream CLI rename also changed the cache directory name (e.g., to `api-cache/`), this line is wrong. Worth verifying against the CLI source — if the cache path was kept as `cloud-api-cache` for back-compat, leave as-is; otherwise update. 3. Minor — sentence-case heading check passes H2s in `api.md` (Subcommands, Authentication, Path-template substitution, Request flags, OpenAPI spec caching, Exit codes and error envelope, Examples, See also) are sentence case per AGENTS.md. Out of scope but worth notingThe pre-existing links to `/docs/pulumi-cloud/cloud-rest-api/` in `dynamic-providers.md` and `mcp-server/index.md` (different from `/docs/reference/cloud-rest-api/`) are not introduced by this PR and resolve via existing aliases — but they're worth normalizing in a follow-up. The "do not merge until autogen lands" gate is correctly identified — the three command-reference links (`/docs/iac/cli/commands/pulumi_api/`, `pulumi_api_list/`, `pulumi_api_describe/`) will 404 until then. No additional blockers from the docs side. Mention me (@claude) if you'd like another pass after addressing these, or want me to look at anything specific in more detail. |
|
Your site preview for commit 59bbb30 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-18887-59bbb30b.s3-website.us-west-2.amazonaws.com |
Lighthouse Performance ReportCommit: 59bbb30 | Metric definitions
|
The upstream CLI standardized on `--output` since `pulumi api` will also get an `--input` flag. Update the CLI guide and the LLM agent index to match. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Summary
pulumi cloud apito top-levelpulumi apiacross custom docs (breaking change — no backwards-compat fallbacks).--formatflag to--outputto match the upstream standardization. See pulumi/pulumi#23072.content/docs/iac/cli/cloud-api.md→api.mdwith an alias for SEO on the old URL.layouts/index.llms.txt) and cross-references incontent/docs/reference/cloud-rest-api/,content/docs/iac/automation-api/_index.md,content/docs/administration/access-identity/access-tokens.md, andcontent/docs/iac/cli/_index.md.content/docs/iac/cli/commands/untouched. They'll be replaced by the next regen run.pulumi_login.md,mcp-server/index.md,dynamic-providers.md,deployments.md,_content.gotmpl, and historical blog posts.Do not merge until
pulumi_api.md,pulumi_api_list.md,pulumi_api_describe.md) land in this repo. Until then, custom doc links to/docs/iac/cli/commands/pulumi_api/,pulumi_api_list/, andpulumi_api_describe/will 404.pulumi cloud api→pulumi api,--format→--output).Test plan
make buildsucceeds locallymake lintpasses/docs/iac/cli/api/renders and all links in it resolve/docs/iac/cli/cloud-api/redirects to/docs/iac/cli/api/(SEO alias)/llms.txtreflects the new command name and--outputflag🤖 Generated with Claude Code