-
Notifications
You must be signed in to change notification settings - Fork 259
Add a CDKTF comparison page #16904
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a CDKTF comparison page #16904
Conversation
Documentation ReviewI've reviewed the changes in this PR that add a CDKTF comparison page and update the cloud-template-transpilers index. Overall, this is a well-written addition with good structure and clear comparisons. Here are my findings: Issues Found1. Incorrect alias in new file (content/docs/iac/comparisons/cloud-template-transpilers/cdktf/_index.md:14)The alias 2. Navigation menu capitalization inconsistency (content/docs/iac/comparisons/cloud-template-transpilers/cdktf/_index.md:8-9)According to STYLE-GUIDE.md, navigation menu items should use Title Case. The menu name should be: Note: "vs." should have a period to match the pattern used in the existing AWS CDK comparison page. 3. Inconsistent punctuation in "vs" (content/docs/iac/comparisons/cloud-template-transpilers/_index.md:31)The new link uses "vs." with a period, but should match the existing pattern in the file which uses "vs." consistently: Current in parent file line 30: This is actually correct and consistent. No change needed here. Style and Content ObservationsStrengths:
Minor observations:
SummaryThis is a high-quality addition to the documentation. The main issues are:
Once these are addressed, the PR will be ready to merge. If you'd like me to review any changes or need help with fixes, feel free to mention me (@claude). |
|
Your site preview for commit e0191fd is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16904-e0191fd4.s3-website.us-west-2.amazonaws.com. |
bebb623 to
be87a99
Compare
|
Your site preview for commit bebb623 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16904-bebb623c.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit be87a99 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16904-be87a993.s3-website.us-west-2.amazonaws.com. |
be87a99 to
090864c
Compare
|
Your site preview for commit 090864c is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16904-090864c8.s3-website.us-west-2.amazonaws.com. |
Documentation ReviewThis PR adds a helpful CDKTF comparison page that rounds out the documentation for teams migrating from CDK-based tools. The content is generally well-written and comprehensive. I've identified several issues to address: Issues Found1. Broken link reference in new CDKTF pageFile: The migration guide link points to a path that doesn't exist: Should be: (Remove the trailing slash, as the file is 2. Inconsistent link format in parent pageFile: The AWS CDK link has a trailing slash, but internal links should be consistent. Since both are pointing to 3. Capitalization inconsistency in headingFile: The intro paragraph mentions "AWS Cloud Development Kit (CDK)" with uppercase CDK, but later refers to "CDK for Terraform (CDKTF)" without explicitly expanding it first in this context. For consistency and clarity, consider expanding CDKTF on first mention in this file: (This is already correct in the current version - no change needed) 4. Minor clarity improvementFile: The sentence "CDKTF is primarily a transpiler" could be clearer. Consider specifying it's a transpiler "that converts code to Terraform JSON" immediately: Positive Observations
Verification Checklist✅ Spelling and grammar correct Overall: This is solid documentation that will help teams understand their migration options from CDKTF. Please address the broken link and consistency issues above. Mention me (@claude) if you'd like me to review the changes or provide additional feedback. |
090864c to
f573df6
Compare
dirien
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
f573df6 to
4a001e9
Compare
|
Your site preview for commit f573df6 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16904-f573df6f.s3-website.us-west-2.amazonaws.com. |
4a001e9 to
e51eb79
Compare
|
Your site preview for commit 4a001e9 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16904-4a001e9a.s3-website.us-west-2.amazonaws.com. |
e51eb79 to
e26b39b
Compare
|
Your site preview for commit e51eb79 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16904-e51eb79f.s3-website.us-west-2.amazonaws.com. |
|
Your site preview for commit e26b39b is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-16904-e26b39b0.s3-website.us-west-2.amazonaws.com. |
This change adds a CDKTF "vs." page to round out the core content for those thinking (and Googling) about migrating to Pulumi.