Skip to content

Revise AWS CDK and CDKTF comparison pages, reorder bottom half#18947

Open
jkodroff wants to merge 2 commits into
masterfrom
jkodroff/revise-compare-transpilers
Open

Revise AWS CDK and CDKTF comparison pages, reorder bottom half#18947
jkodroff wants to merge 2 commits into
masterfrom
jkodroff/revise-compare-transpilers

Conversation

@jkodroff
Copy link
Copy Markdown
Member

Revises the AWS CDK and CDKTF comparison pages per epic #18673: neutral tone, structured comparison table, key differences in sentences, adoption guidance, and an SEO/AEO-tuned FAQ. Promotes both pages out of the "cloud-template-transpilers" subcategory, removes the landing page, and folds its intro into the two pages. All legacy URLs are preserved via aliases.

Also reorders the bottom half of the IaC comparisons nav: Crossplane moves up to slot 5; Cloud SDKs / Serverless Framework / Chef & Puppet / Custom Solutions shift to give a more logical grouping. Terraform, CloudFormation, AWS CDK, CDKTF, OpenTofu, and Kubernetes YAML keep their existing positions.

Changes

  • New content/docs/iac/comparisons/aws-cdk.md (rewritten + promoted)
  • New content/docs/iac/comparisons/cdktf.md (rewritten + promoted)
  • Deleted content/docs/iac/comparisons/cloud-template-transpilers/ directory
  • Updated _index.md bullet list and cloudformation.md next-step link
  • Reordered menu weights on crossplane.md, serverless.md, chef-puppet-etc.md, cloud-sdks.md, custom.md

Closes #18899
Closes #18901

jkodroff and others added 2 commits May 13, 2026 15:43
Promotes the AWS CDK and CDKTF pages out of the
"cloud-template-transpilers" subcategory and rewrites both per
epic #18673: neutral tone, structured comparison table, key
differences in sentences, adoption guidance, and an FAQ section
tuned for SEO/AEO. Removes the "Cloud Template Transpilers"
landing page and folds its intro content into the two pages.
Preserves all legacy URLs via aliases.

Closes #18899
Closes #18901

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Moves Crossplane up to slot 5, demotes Cloud SDKs to slot 10,
and shifts Serverless Framework / Chef & Puppet / Custom
Solutions to give a more logical grouping. Terraform,
CloudFormation, AWS CDK, CDKTF, OpenTofu, and Kubernetes YAML
keep their existing positions.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented May 13, 2026

Docs review

Overall this is a strong rewrite: neutral tone, well-structured comparison tables, clean key-differences narrative, and a focused FAQ. Heading case, ordered-list style (1. for every item), and meta descriptions are all within style. Alias coverage on aws-cdk.md is thorough — both the AWS CDK historical paths and the deleted landing page's aliases are preserved. A few items worth a second look:

Non-canonical link path (repeated)

content/docs/iac/comparisons/cdktf.md links to /docs/iac/using-pulumi/extending-pulumi/use-terraform-module/ in four places (lines 43, 64, 105, and 132). That URL is an alias on the actual page; the canonical path is /docs/iac/guides/building-extending/using-existing-tools/use-terraform-module/. Per AGENTS.md, links within /docs/ should use the canonical path so they don't break if aliases are ever cleaned up. The links work today via redirect, so this isn't a build-time issue — just a hygiene fix.

Example fix for line 105:

```suggestion

  1. Consume Terraform modules directly. Pulumi can reference Terraform modules directly by generating language-specific SDKs on demand, so existing module investment is preserved.
    ```

(Same swap applies to the other three occurrences.)

CDKTF aliases — worth a quick sanity check

cdktf.md declares one alias: /docs/iac/comparisons/cloud-template-transpilers/cdktf/. By contrast, aws-cdk.md preserves several deep-history paths (/docs/intro/vs/..., /docs/concepts/vs/..., /docs/iac/concepts/vs/...). The deleted cloud-template-transpilers/cdktf/_index.md didn't declare these either, so this likely matches prior behavior — but if /docs/iac/concepts/vs/cloud-template-transpilers/cdktf/ (or similar) was ever a live URL, it's worth adding the analogous aliases here. Easy to verify by checking Search Console or server logs for traffic to those paths.

Pre-existing inconsistency in the comparisons landing page

content/docs/iac/comparisons/_index.md line 39 has /docs/iac/comparisons/cloud-sdks (no trailing slash) while every other bullet has one. This was already in master, so feel free to defer — but since the bullet list is being touched in this PR, it's a low-cost fix:

```suggestion

Things checked and looking good

  • Aliases on aws-cdk.md cover all historical paths plus the deleted landing page's URL family
  • Menu weight reorder is internally consistent across the seven touched files and matches the bullet list in _index.md
  • All linked targets I spot-checked resolve (/product/neo/, /docs/deployments/deployments/drift/, /docs/iac/guides/clouds/aws/cdk/, migrating-from-cdk/using-pulumi-cdk/, migrating-from-cdk/migrating-existing-cdk-app/)
  • Meta descriptions are 159 chars (aws-cdk) and 152 chars (cdktf) — both under the 160-char cap
  • CDKTF references consistently use past tense for product behavior and present tense for migration tooling
  • H2/H3 headings are sentence case throughout
  • cloudformation.md "Next steps" link correctly updated to the new /aws-cdk/ path

Mention me (@claude) if you'd like another pass after revisions, or want a fact-check on any specific claim in the comparison tables.

@pulumi-bot
Copy link
Copy Markdown
Collaborator

@CamSoper CamSoper self-requested a review May 13, 2026 20:31
Copy link
Copy Markdown
Contributor

@CamSoper CamSoper left a comment

Choose a reason for hiding this comment

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

A fact-checking pass against the comparison-table claims surfaced a handful of items that look like contradictions. Passing them along for you to investigate — I haven't manually re-verified each one, so please treat these as leads, not confirmed errors. Happy to dig in further on any of them if you want a second pair of eyes.

Likely contradictions (please verify):

  1. AWS CDK Go support — flagged the "(developer preview)" qualifier as outdated. AWS's Go guide says Go is "fully-supported... and considered stable."

    • content/docs/iac/comparisons/aws-cdk.md:39, 45
  2. CloudFormation Hooks language support — flagged as Java + Python only, not Java/Python/TypeScript. AWS Hooks prerequisites cited. TypeScript is supported for CFN resource-type plugins, which is a different surface.

    • aws-cdk.md:55, 83
  3. SOC 2 in pre-built policy packs — not on the list, which currently has CIS, CIS Kubernetes, HITRUST CSF 11.5, NIST SP 800-53, PCI DSS v4.0.1, Pulumi Best Practices, and AWS Organizations Tag Policies.

    • aws-cdk.md:55, 83, cdktf.md:52, 76
  4. pulumi convert --from cloudformation — flagged as not a real command. The pulumi convert docs list valid --from sources as yaml/terraform/bicep/arm/kubernetes only, and the from-cloudformation migration guide recommends Pulumi Neo. If that's right, the Adoption option 2 and the FAQ migration option 2 may need to be removed or replaced.

    • aws-cdk.md:116 (Adoption option 2) and aws-cdk.md:130 (FAQ option 2)
  5. Broken link — cdktf.md:60 points to /docs/iac/using-pulumi/testing/ which 404s. The actual page is at /docs/iac/guides/testing/.

Minor / softer flags (optional, not blocking):

  • "AWS CDK released in 2018" — preview was 2018, GA was July 2019.
  • "CDKTF... a HashiCorp project... released in 2020" — was a joint AWS+HashiCorp preview launch July 2020; GA 2022.
  • aws-native "same-day coverage" — registry page hedges with "typically supports new AWS features on the day of launch."
  • pulumi-terraform-migrate README self-identifies as experimental.

Everything else in the fact-check came back clean — aliases, menu weights, closing issues (#18899, #18901, epic #18673), all other internal links, PR description vs diff. Once the contradictions are sorted I'll re-approve.

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.

Comparisons: Pulumi vs. AWS CDK Comparisons: Pulumi vs. CDKTF

3 participants