Skip to content

Remove "Crosswalk" branding in favor of "awsx" - #2988

Merged
jkodroff merged 1 commit into
masterfrom
jkodroff/remove-crosswalk
Aug 28, 2026
Merged

Remove "Crosswalk" branding in favor of "awsx"#2988
jkodroff merged 1 commit into
masterfrom
jkodroff/remove-crosswalk

Conversation

@jkodroff

Copy link
Copy Markdown
Member

Fixes #2987. Part of pulumi/registry#10607 — we no longer refer to any library as "Crosswalk", so every reference to the term is replaced with awsx, the name of the package these examples actually consume.

Most of it lived in aws-ts-vpc-with-ecs-fargate-py, where the term was baked into names as well as prose. This does the full rename (the "Part 2" the issue flagged as needing a decision):

Old New
vpc-crosswalk-ts/ vpc-awsx-ts/
project crosswalk-vpc awsx-vpc
project fargate-with-crosswalk-vpc fargate-with-awsx-vpc
tag "crosswalk": "yes" "awsx": "yes"
tag "crosswalk-vpc": "yes" "awsx-vpc": "yes"
/docs/guides/crosswalk/aws/… /docs/iac/guides/clouds/aws/…

The pasted pulumi up / pulumi stack output transcripts in the READMEs are updated too, so the samples match what the renamed projects now actually print.

Also fixed two mentions outside the issue's stated scope, both one-liners:

  • aws-go-fargate/main.go — "using AWS Crosswalk" comment (it does import pulumi-awsx)
  • aws-ts-apigateway-lambda-serverless/index.ts — stale crosswalk doc URL

The old /docs/guides/crosswalk/aws/… URLs were stale as well as off-brand; the new ones are where they already redirect to (verified: new 200, old 301).

Drive-by fix: ecs-fargate-python/README.md linked to ./vpc-crosswalk-ts and ./ecs-fargate-python, both of which resolve against ecs-fargate-python/ and pointed at nothing. Corrected to ../.

Why it has to happen here

pulumi/registry generates themes/default/content/registry/packages/aws/how-to-guides/aws-ts-vpc-with-ecs-fargate-py.md from these READMEs via mktutorial, and that file is marked "generated by a tool — do not edit". The published page only stops saying "Crosswalk" once these sources change.

⚠️ Breaking, and deliberate

  • The ?template= deploy-button URL for the old vpc-crosswalk-ts/README.md path will 404. Anyone linking to it externally will need to update.
  • The project rename changes the StackReference path (<org>/crosswalk-vpc/<stack><org>/awsx-vpc/<stack>) for anyone with a stack already deployed from this example.

Verification

  • grep -rin crosswalk across the repo returns nothing.
  • black --check passes on the changed Python file.
  • The renamed directory is self-contained (tsconfig.json uses files: ["index.ts"] and a relative outDir), and nothing in misc/test/, Makefile, scripts/, or .github/ referenced the old path — there is no integration test for this example, so there's nothing in the test matrix to update.
  • Local go build and eslint couldn't run (full disk / ESLint deps not installed locally), so CI is the real check on those. Both edits there are a single comment/string line.

🤖 Generated with Claude Code

https://claude.ai/code/session_01KiBQ3FUHakhvydtYErXfXi

@jkodroff
jkodroff requested a review from cnunciato August 27, 2026 17:12

@cnunciato cnunciato left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Few lil' things to fix up, but otherwise 👍🏻 !

Comment thread aws-go-fargate/main.go Outdated
Comment thread aws-ts-vpc-with-ecs-fargate-py/README.md Outdated
options:
virtualenv: venv
description: Fargate with crosswalk vpc
description: Fargate with awsx vpc

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
description: Fargate with awsx vpc
description: Fargate with AWSx vpc

I'll stop commenting on these and leave the rest to search & replace. 😄

Comment thread aws-ts-vpc-with-ecs-fargate-py/ecs-fargate-python/__main__.py Outdated
### What Is This?

This example uses [Pulumi CrossWalk for AWS](https://www.pulumi.com/docs/guides/crosswalk/aws/#pulumi-crosswalk-for-aws) for deploying your own vpc using crosswalk [VPC](https://www.pulumi.com/docs/guides/crosswalk/aws/vpc/). The VPC is built in `typescript`
This example uses the Pulumi [awsx](https://www.pulumi.com/docs/iac/guides/clouds/aws/) package for deploying your own vpc using the awsx [VPC](https://www.pulumi.com/docs/iac/guides/clouds/aws/vpc/) component. The VPC is built in `typescript`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
This example uses the Pulumi [awsx](https://www.pulumi.com/docs/iac/guides/clouds/aws/) package for deploying your own vpc using the awsx [VPC](https://www.pulumi.com/docs/iac/guides/clouds/aws/vpc/) component. The VPC is built in `typescript`
This example uses the Pulumi [AWXx](https://www.pulumi.com/docs/iac/guides/clouds/aws/) package for deploying your own VPC using the AWSx [VPC](https://www.pulumi.com/docs/iac/guides/clouds/aws/vpc/) component. The VPC is written in TypeScript.

Comment thread aws-ts-vpc-with-ecs-fargate-py/vpc-awsx-ts/README.md Outdated
We no longer refer to any library as "Crosswalk". Every reference to the
term is replaced with the name of the package these examples actually
consume: "AWSx" in prose, "awsx" where it's an identifier.

Most of it lived in aws-ts-vpc-with-ecs-fargate-py, where the term was
baked into names as well as prose:

- Renamed vpc-crosswalk-ts/ to vpc-awsx-ts/
- Renamed the Pulumi projects crosswalk-vpc -> awsx-vpc and
  fargate-with-crosswalk-vpc -> fargate-with-awsx-vpc
- Renamed the "crosswalk"/"crosswalk-vpc" resource tags to
  "awsx"/"awsx-vpc"
- Updated the pasted `pulumi up` and `pulumi stack output` transcripts in
  the READMEs so the samples match what the renamed projects now print

Also fixed two mentions elsewhere: the "using AWS Crosswalk" comment in
aws-go-fargate (which does import pulumi-awsx), and a stale doc URL in
aws-ts-apigateway-lambda-serverless.

The /docs/guides/crosswalk/aws/... URLs were stale as well as off-brand;
they now point at /docs/iac/guides/clouds/aws/..., which is where they
redirect to.

While in ecs-fargate-python/README.md, corrected two relative links that
resolved against ecs-fargate-python/ and pointed at nothing.

This has to happen here because pulumi/registry generates its
aws-ts-vpc-with-ecs-fargate-py how-to-guide from these READMEs via
mktutorial, and that file is marked do-not-edit.

Note: renaming the directory breaks the old ?template= deploy-button URL,
and the project rename changes the StackReference path for anyone with a
stack deployed from the old names.

Fixes #2987

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KiBQ3FUHakhvydtYErXfXi
@jkodroff
jkodroff force-pushed the jkodroff/remove-crosswalk branch from 3d2cd18 to 4b3d3d9 Compare August 28, 2026 14:02
@jkodroff
jkodroff merged commit 159b1dd into master Aug 28, 2026
14 checks passed
@jkodroff
jkodroff deleted the jkodroff/remove-crosswalk branch August 28, 2026 14:07
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.

Remove "Crosswalk" branding from aws-ts-vpc-with-ecs-fargate-py

3 participants