Skip to content

Conversation

asafashirov
Copy link
Contributor

No description provided.

Copy link
Contributor

claude bot commented Sep 23, 2025

Review Summary

This PR adds a new getting started experience across 4 cloud providers. The content is well-structured and comprehensive, but there are several issues that need to be addressed before merging.

Issues Found

Critical Issues

Missing newlines at end of files (Lines: EOF)
All 5 new files are missing the required newline at the end:

  • content/start-now-1/_index.md:23
  • content/start-now-1/aws/_index.md:305
  • content/start-now-1/azure/_index.md:341
  • content/start-now-1/gcp/_index.md:310
  • content/start-now-1/kubernetes/_index.md:498

This violates the absolute prohibition in AGENTS.md: "New files: Must always end with a newline."

Style Guide Violations

Heading capitalization issues

  • content/start-now-1/aws/_index.md:295: "What's Next?" should be "What's next?" (H2+ should be sentence case per STYLE-GUIDE.md:29)
  • content/start-now-1/azure/_index.md:326: Same issue
  • content/start-now-1/gcp/_index.md:295: Same issue
  • content/start-now-1/kubernetes/_index.md:485: Same issue

Semantic line break violations
Multiple instances where sentences are not properly broken across lines (STYLE-GUIDE.md:65):

  • Long sentences in meta descriptions should be broken
  • Several paragraph sentences should start new lines

Content Issues

Language consistency

  • content/start-now-1/aws/_index.md:16: "Get started with Pulumi Cloud" - should use consistent capitalization
  • Several instances of informal language like "Get started" vs "Get Started" need consistency

Link verification needed
The following external links should be verified:

  • https://app.pulumi.com/signup (appears in all files)
  • https://slack.pulumi.com (appears in all files)
  • GitHub example links need verification

Technical Accuracy

Code examples
The code examples appear technically sound, but should be tested to ensure they work as documented. The examples follow established patterns from the existing documentation.

Command sequences
Installation and configuration commands look correct, but recommend testing across all supported platforms.

Positive Aspects

  • Comprehensive coverage across major cloud providers
  • Consistent structure and formatting across all files
  • Good use of Hugo shortcodes and choosers
  • Clear step-by-step progression
  • Helpful "What's next?" sections with relevant links

Recommendations

  1. Immediate fixes required:

    • Add newlines to end of all files
    • Fix heading capitalization (H2+ to sentence case)
    • Apply semantic line breaks throughout
  2. Before merging:

    • Test all code examples to ensure they work
    • Verify all external links resolve correctly
    • Consider testing installation commands across platforms
  3. Style improvements:

    • Standardize "Get started" vs "Get Started" usage
    • Review for consistent Pulumi product name usage

The content quality is high and the structure is excellent. Once the style guide violations are addressed, this will be a valuable addition to the getting started experience.

@pulumi-bot
Copy link
Collaborator

Your site preview for commit 71ad0f9e is ready! 🎉

http://www-testing-pulumi-docs-origin-pr-16065-71ad0f9e.s3-website.us-west-2.amazonaws.com.

@pulumi-bot
Copy link
Collaborator

@meagancojocar
Copy link
Collaborator

Asaf mind adding a PR description explaining what change we are making? Is Joe the only reviewer we want?

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.

3 participants