Skip to content

[Sandbox] Define terms and fix steps in the migration guide - #34569

Closed
ghostwriternr wants to merge 2 commits into
sandbox/audit-termsfrom
sandbox/audit-migration-clarity
Closed

ghostwriternr wants to merge 2 commits into
sandbox/audit-termsfrom
sandbox/audit-migration-clarity

Conversation

@ghostwriternr

Copy link
Copy Markdown
Member

Summary

The migration guide used terms such as container application, instance type, interception, outbound handler, cloudflared, WorkerEntrypoint, and SquashFS before defining them, and several steps did not work as written.

Each page now defines a term at first use, and links the page that owns a limit instead of restating it. Other fixes:

  • The inventory search finds exec() and execStream(), and shows its real output.
  • Process IDs are checked against one pattern before any process method or rm -rf.
  • The background processes step names exactly what to copy from each page.
  • The tunnel cleanup declares its shell variables and pages through all results.
  • The OpenCode step routes through the existing fetch() handler instead of adding a second one.
  • The API map said enableInternet has a default. It now says to pass it on every start() call.
  • Pages link the intercept limit and the benchmark post instead of stating numbers.

Documentation checklist

The first migration pages used container application, instance type,
interception, snapshot, outbound handler, and restart without saying
what they are. The inventory search missed exec(), the move-in step
for background processes left readers to work out which parts of two
pages to copy, process IDs reached rm -rf unchecked, and several
pages restated limits and outcomes that the Containers API owns.

Define each term at first use, add exec() and execStream() to the
search with its real output, name exactly what to copy, check IDs
against one pattern before any process method or rm -rf, and link
the owning pages instead of restating them.
The later migration pages used cloudflared, WorkerEntrypoint, props,
CA, FUSE, and SquashFS without saying what they are, stated a fixed
number of intercept targets and a benchmark figure, and left the API
map saying enableInternet has a default. The tunnel cleanup used
undeclared shell variables and read only the first page of results,
and the OpenCode step clashed with an existing fetch() handler.

Define each term at first use, link the intercept limit and the
benchmark post instead of numbers, say that every start() passes
enableInternet, declare the cleanup variables and page through the
results, and route OpenCode from the existing handler.
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 23, 2026 •

Copy link
Copy Markdown

🚀 Deploying Preview to Cloudflare 🚀

Preview URL: https://sandbox-audit-migration-clarity.previews.developers.cloudflare.com (commit 3a8d727)

This URL reflects your latest Preview deployment

Preview Deployments by commit

Status Deployment URL Commit Updated (UTC) See this deployment's details
  • Build: Success ✅
  • Deployment: Success ✅

View logs ↗
https://bc68d46f.previews.developers.cloudflare.com 3a8d727 2026-10-23T16:33:47.683Z Visit the dashboard ↗

@github-actions

Copy link
Copy Markdown
Contributor

Worker Preview URL: https://gh-sandbox-audit-migration-clarity.previews.developers.cloudflare.com
Worker Preview Deployment URL: https://5da77b32.previews.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/sandbox/sdk/migrate/tunnels/ https://gh-sandbox-audit-migration-clarity.previews.developers.cloudflare.com/sandbox/sdk/migrate/tunnels/
https://developers.cloudflare.com/sandbox/sdk/migrate/ https://gh-sandbox-audit-migration-clarity.previews.developers.cloudflare.com/sandbox/sdk/migrate/
https://developers.cloudflare.com/sandbox/sdk/migrate/replace-the-sandbox-class/ https://gh-sandbox-audit-migration-clarity.previews.developers.cloudflare.com/sandbox/sdk/migrate/replace-the-sandbox-class/
https://developers.cloudflare.com/sandbox/sdk/migrate/background-processes/ https://gh-sandbox-audit-migration-clarity.previews.developers.cloudflare.com/sandbox/sdk/migrate/background-processes/
https://developers.cloudflare.com/sandbox/sdk/migrate/commands/ https://gh-sandbox-audit-migration-clarity.previews.developers.cloudflare.com/sandbox/sdk/migrate/commands/
https://developers.cloudflare.com/sandbox/sdk/migrate/changes-in-1-0/ https://gh-sandbox-audit-migration-clarity.previews.developers.cloudflare.com/sandbox/sdk/migrate/changes-in-1-0/
https://developers.cloudflare.com/sandbox/sdk/migrate/api-map/ https://gh-sandbox-audit-migration-clarity.previews.developers.cloudflare.com/sandbox/sdk/migrate/api-map/
https://developers.cloudflare.com/sandbox/sdk/migrate/files/ https://gh-sandbox-audit-migration-clarity.previews.developers.cloudflare.com/sandbox/sdk/migrate/files/
https://developers.cloudflare.com/sandbox/sdk/migrate/other-features/ https://gh-sandbox-audit-migration-clarity.previews.developers.cloudflare.com/sandbox/sdk/migrate/other-features/
https://developers.cloudflare.com/sandbox/sdk/migrate/outbound-traffic/ https://gh-sandbox-audit-migration-clarity.previews.developers.cloudflare.com/sandbox/sdk/migrate/outbound-traffic/
https://developers.cloudflare.com/sandbox/sdk/migrate/plan-the-move/ https://gh-sandbox-audit-migration-clarity.previews.developers.cloudflare.com/sandbox/sdk/migrate/plan-the-move/
https://developers.cloudflare.com/sandbox/sdk/migrate/bucket-mounts/ https://gh-sandbox-audit-migration-clarity.previews.developers.cloudflare.com/sandbox/sdk/migrate/bucket-mounts/
https://developers.cloudflare.com/sandbox/sdk/migrate/code-interpreter/ https://gh-sandbox-audit-migration-clarity.previews.developers.cloudflare.com/sandbox/sdk/migrate/code-interpreter/
https://developers.cloudflare.com/sandbox/sdk/migrate/backups/ https://gh-sandbox-audit-migration-clarity.previews.developers.cloudflare.com/sandbox/sdk/migrate/backups/
https://developers.cloudflare.com/sandbox/sdk/migrate/move-side-by-side/ https://gh-sandbox-audit-migration-clarity.previews.developers.cloudflare.com/sandbox/sdk/migrate/move-side-by-side/

@cloudflare-docs-bot

Copy link
Copy Markdown
Contributor

@ghostwriternr This draft pull request has had no activity for 3 days. It will close after 7 days of inactivity. Transition to ready for review if ready. A codeowner can comment /draft-never-stale to keep it open.

@cloudflare-docs-bot

Copy link
Copy Markdown
Contributor

@ghostwriternr Closing this draft pull request after 7 days of inactivity. Re-open at a later date and transition to ready for review when you are ready if you seek review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant