Refactor and update get started guides for Azure, GCP, and Kubernetes #16605
Conversation
…nhance deploy stack and destroy stack sections, and streamline project review content. Update GCP and Kubernetes guides to focus on installation steps. Introduce a new shortcode for installation instructions.
CamSoper
changed the title
This comment was marked as outdated.
This comment was marked as outdated.
|
Your site preview for commit 387d006 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16605-387d006f.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit 860ac99 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16605-860ac995.s3-website.us-west-2.amazonaws.com. |
…key as stack outputs in create-project and deploy-stack guides.
…ct destroy-stack section.
…re, GCP, and Kubernetes guides
|
Your site preview for commit 972d821 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16605-972d8218.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit e303c8d is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16605-e303c8d2.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit dcdda70 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16605-dcdda70d.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit 68ac3ad is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16605-68ac3ad4.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit e02b4b3 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16605-e02b4b3f.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit 573a497 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16605-573a4979.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit b9eabe6 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16605-b9eabe6c.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit a9003f2 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16605-a9003f21.s3-website.us-west-2.amazonaws.com. |
Documentation ReviewI have reviewed the changes to refactor and update the Get Started guides for Azure, GCP, and Kubernetes to follow the same structure as AWS. Here are my findings: Overall AssessmentThis is a comprehensive refactoring that successfully aligns the Azure, GCP, and Kubernetes Get Started guides with the AWS guide structure. The changes improve consistency and user experience across all cloud providers. Issues Found1. Missing aliases verification (SEO Critical)The following files were deleted without obvious replacements:
Per AGENTS.md, you must:
2. C# code formatting inconsistencyIn content/docs/iac/get-started/aws/create-component.md:555, consider using Array.Empty for better C# idiomaticity. 3. Unnecessary explicit namespaceIn content/docs/iac/get-started/aws/create-component.md:756 and content/docs/iac/get-started/aws/create-project.md:299, the change from Deployment.RunAsync() to Pulumi.Deployment.RunAsync() is inconsistent with the using Pulumi statement. Either remove the explicit namespace or remove the using statement for consistency. 4. Frontmatter identifier inconsistencySome files have the identifier field in frontmatter (e.g., azure-get-started.configure), but others do not. Review whether identifiers should be added consistently across all similar pages. Positive Changes
Next Steps
@claude Mention me if you would like help addressing any of these issues or if you need additional reviews after making changes. |
|
@claude -
Thank you! Here's a cookie. 🍪 |
|
Claude finished @CamSoper's task —— View job Completed your request! ✓Thanks for the cookie! 🍪 Here's what I did: Tasks
Summary1. Aliases added ✓
2. C# code formatting (ignored per your request) 3. Namespace qualification (ignored per your request) 4. Frontmatter identifiers ✓ All changes have been committed and pushed to your branch --- | |
Added aliases to Azure, GCP, and Kubernetes overview pages for the deleted deploy-changes and review-project files to maintain SEO and prevent broken links. Co-authored-by: Cam Soper <CamSoper@users.noreply.github.com>
|
Your site preview for commit 9ea093d is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16605-9ea093d6.s3-website.us-west-2.amazonaws.com. |
|
|
||
| {{% /choosable %}} | ||
|
|
||
| Before you begin, watch this overview of how to deploy Kubernetes infrastructure with Pulumi: |
There was a problem hiding this comment.
Huh, I didn't realize we have this. Isn't it possible this will lead to dropoff? The NEXT button is below the big video and it sort of makes it seem like I need to watch a 10 minute video before proceeding. I like the idea of having content like this but maybe it should go on the final "next steps" page?
There was a problem hiding this comment.
I had assumed that somebody stuck it there on purpose. I like the idea of moving it to the next steps, I'll do that.
This is a significant update to the Get Started experience for Azure, Google Cloud, and Kubernetes users.
Each of these three Get Started tutorials has been rewritten to mirror the AWS version as closely as possible, with some constraints based on the specific project template.
The AWS Get Started got some formatting consistency updates and minor language adjustments.
The Get Started experience was tested end-to-end for each cloud both manually and with AI assistance.
Apologies for the large PR! In retrospect, I should have broken this into 3.
Fixes #16104