Skip to content

Conversation

@CamSoper
Copy link
Contributor

Less cut down, still tightened prose.

Also fixes #16517

CamSoper and others added 5 commits November 10, 2025 18:38
- Update notes shortcode from positional to named parameter syntax
- Add missing trailing newline at end of file
- Add trailing slash to onboarding guide link for consistency

Co-authored-by: Cam Soper <CamSoper@users.noreply.github.com>
@claude
Copy link
Contributor

claude bot commented Nov 10, 2025

Documentation Review

I've reviewed the changes in this PR. Overall, the writing is tighter and more concise. Here are my findings:

Issues Found

1. File moved without complete verification (SEO Warning)

File: content/docs/iac/concepts/pulumi-cloud.md (moved from content/docs/deployments/get-started/what-is-it.md)

The file has been moved and includes aliases in the frontmatter:

aliases:
  - /docs/deployments/get-started/what-is-it/
  - /docs/pulumi-cloud/get-started/what-is-it/

⚠️ Action required: After this PR merges, run the alias verification scripts in /scripts/alias-verification/ to ensure all historical paths are properly captured.

2. Product name change needs verification

File: content/docs/iac/concepts/pulumi-cloud.md:84

The link text changed from "Pulumi CrossGuard" to "Pulumi Policies" with a different target URL (/docs/insights/policy/ instead of /crossguard/).

- Pulumi Cloud offers organization-wide policies thanks to Pulumi's policy as code engine, [Pulumi CrossGuard](/crossguard/), allowing you to enforce policies
+ Pulumi Cloud offers organization-wide policies thanks to Pulumi's policy as code engine, [Pulumi Policies](/docs/insights/policy/), allowing you to enforce policies

Please confirm this product name change is intentional and that the new link target is correct.

3. Verify file ends with newline

The diff was truncated in the output, so I cannot verify the file ends with a newline as required by STYLE-GUIDE.md. Please confirm the file ends with a newline character.

Positive Changes

  1. Improved conciseness: The prose is tighter throughout, removing unnecessary words while maintaining clarity.
  2. Better heading structure: Moving "Pulumi Cloud" section to the concepts area improves discoverability.
  3. Link updates: Internal links throughout have been updated to reflect the new file location.
  4. Consistent terminology: Better use of "Pulumi Cloud" without unnecessary articles.
  5. Improved introduction: The new opening paragraph is clearer about the relationship between open source Pulumi and Pulumi Cloud.

Minor Observations

File: content/docs/iac/concepts/_index.md

The restructuring of the concepts index page looks good. The new layout places "Pulumi Cloud" prominently after "How Pulumi works" which makes logical sense for new users.

File: layouts/shortcodes/cli-note.html

The shortcode path update from what-is-it to pulumi-cloud correctly reflects the file move.

Summary

  • Critical issues: 0
  • Warnings: 2 (verify aliases with script, confirm product name change)
  • Style issues: 0
  • Spelling/grammar issues: 0

The changes improve readability and content organization. The main items to verify are the product name change and running the alias verification script post-merge.


Mention me (@claude) if you'd like me to review any revisions or need help with fixes!

@pulumi-bot
Copy link
Collaborator

Copy link
Member

@joeduffy joeduffy left a comment

Choose a reason for hiding this comment

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

LGTM 👍🚀

@CamSoper CamSoper marked this pull request as ready for review November 10, 2025 23:55
@CamSoper CamSoper merged commit 772cc3d into master Nov 10, 2025
13 of 14 checks passed
@CamSoper CamSoper deleted the CamSoper/less-drastic-edit-16517 branch November 10, 2025 23:55
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.

Move 'What is Pulumi Cloud?' Explanation to More Prominent Location in Docs

4 participants