Skip to content

Conversation

@cnunciato
Copy link
Contributor

@cnunciato cnunciato commented Dec 23, 2025

This change adds a CDKTF "vs." page to round out the core content for those thinking (and Googling) about migrating to Pulumi.

@claude
Copy link
Contributor

claude bot commented Dec 23, 2025

Documentation Review

I'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 Found

1. Incorrect alias in new file (content/docs/iac/comparisons/cloud-template-transpilers/cdktf/_index.md:14)

The alias /docs/iac/concepts/vs/cloud-template-transpilers/aws-cdk/ appears to be incorrect. This alias points to AWS CDK, but the file is about CDKTF. This should likely be:

- /docs/iac/concepts/vs/cloud-template-transpilers/cdktf/

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:

menu:
    iac:
        name: Pulumi vs. CDK for Terraform (CDKTF)
        parent: iac-comparisons-transpilers
        weight: 4

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: * [Pulumi vs. AWS Cloud Development Kit (CDK)]
New addition line 31: * [Pulumi vs. CDK for Terraform (CDKTF)]

This is actually correct and consistent. No change needed here.

Style and Content Observations

Strengths:

  • Clear deprecation warning prominently displayed
  • Excellent feature comparison table with specific details
  • Good use of code examples showing similarity between CDKTF and Pulumi
  • Proper use of internal links and cross-references
  • Consistent heading structure (sentence case for H2+)
  • Clear migration guidance at the end
  • Proper use of notes shortcode with type="warning"

Minor observations:

  • The comparison is comprehensive and addresses key differences well
  • Code examples are realistic and demonstrate the similarity effectively
  • The table formatting style override is appropriate for readability
  • The content accurately reflects the deprecation status of CDKTF

Summary

This is a high-quality addition to the documentation. The main issues are:

  1. An incorrect alias that needs to be fixed (points to aws-cdk instead of cdktf)
  2. A minor menu capitalization issue for consistency with style guidelines

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).

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@cnunciato cnunciato marked this pull request as ready for review December 23, 2025 21:35
@claude
Copy link
Contributor

claude bot commented Dec 23, 2025

Documentation Review

This 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 Found

1. Broken link reference in new CDKTF page

File: content/docs/iac/comparisons/cloud-template-transpilers/cdktf/_index.md
Line: 109

The migration guide link points to a path that doesn't exist:

/docs/iac/guides/migration/migrating-to-pulumi/from-terraform/

Should be:

/docs/iac/guides/migration/migrating-to-pulumi/from-terraform

(Remove the trailing slash, as the file is from-terraform.md, not from-terraform/_index.md)

For teams interested in migrating from CDKTF, Pulumi has several options, including automated tooling that can convert your CDKTF code to Pulumi and import your existing Terraform state. To learn more, see [Migrating from CDKTF to Pulumi](/docs/iac/guides/migration/migrating-to-pulumi/from-terraform).

2. Inconsistent link format in parent page

File: content/docs/iac/comparisons/cloud-template-transpilers/_index.md
Line: 30

The AWS CDK link has a trailing slash, but internal links should be consistent. Since both are pointing to _index.md files in their directories, both should have trailing slashes for consistency:

* [Pulumi vs. AWS Cloud Development Kit (CDK)](/docs/iac/comparisons/cloud-template-transpilers/aws-cdk/)
* [Pulumi vs. CDK for Terraform (CDKTF)](/docs/iac/comparisons/cloud-template-transpilers/cdktf/)

3. Capitalization inconsistency in heading

File: content/docs/iac/comparisons/cloud-template-transpilers/_index.md
Line: 22

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:

Because of [the challenges of writing raw YAML/JSON by hand](/docs/concepts/vs/cloud-templates), two notable projects exist to compile higher-level languages into intermediate formats for deployment. Two of the most popular projects are AWS Cloud Development Kit (CDK), an AWS Labs project created in 2018, and CDK for Terraform (CDKTF), a HashiCorp project created in 2020 and [deprecated](/blog/cdktf-is-deprecated-whats-next-for-your-team/) in 2025.

(This is already correct in the current version - no change needed)


4. Minor clarity improvement

File: content/docs/iac/comparisons/cloud-template-transpilers/cdktf/_index.md
Line: 31

The sentence "CDKTF is primarily a transpiler" could be clearer. Consider specifying it's a transpiler "that converts code to Terraform JSON" immediately:

CDK for Terraform (CDKTF) is a tool that allows you to define infrastructure using general-purpose programming languages like TypeScript, Python, Go, C#, and Java. Like [AWS CDK](/docs/iac/comparisons/cloud-template-transpilers/aws-cdk/), CDKTF is a _transpiler_ that converts your code into Terraform JSON format, which is then deployed by the Terraform CLI.

Positive Observations

  • The comparison table is comprehensive and well-structured
  • Code examples clearly demonstrate the similarities between CDKTF and Pulumi
  • The deprecation note at the top is appropriately formatted
  • Frontmatter is complete with proper meta descriptions
  • The content follows the style guide for headings (H1 in Title Case, H2+ in Sentence case)
  • Good use of internal linking to related documentation

Verification Checklist

✅ Spelling and grammar correct
✅ All headings properly formatted (Title Case for H1, Sentence case for H2+)
✅ Menu configuration follows Title Case convention
✅ Frontmatter complete and appropriate
✅ Code examples are clear and realistic
⚠️ One broken link needs fixing (migration guide)
⚠️ Trailing slash inconsistency needs resolution
✅ Content is accurate and current
✅ Appropriate use of the notes shortcode for deprecation warning


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.

Copy link
Contributor

@dirien dirien left a comment

Choose a reason for hiding this comment

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

LGTM!

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@pulumi-bot
Copy link
Collaborator

@cnunciato cnunciato merged commit cb98758 into master Dec 23, 2025
8 checks passed
@cnunciato cnunciato deleted the cnunciato/cdktf-page branch December 23, 2025 22:10
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.

4 participants