Adds draft docs for connecting to remote resources during local dev (hybrid dev) #22940

korinne · 2025-06-05T20:12:29Z

Summary

Starting the draft docs for connecting to remote resources during local development.

###To do

Need to update Environments page to talk about how you can configure remote: true differently across environments. Ex: You can wrangler dev --env staging with bindings configured with remote: true
I probably need to change remote : true to "remote" : true (thought this is wrangler.json specific -- wrangler.toml would be remote = true
Add full API reference @penalosa and @dario-piotrowicz would love help
We'll need to separate update all the config docs and other relevant pages
Might be good to have a use-cases / examples section
Update the matrix for per-binding remote connections

…hybrid dev)

github-actions · 2025-06-05T20:12:54Z

This PR changes current filenames or deletes current files. Make sure you have redirects set up to cover the following paths:

/workers/local-development/bindings-per-env/
/workers/local-development/environment-variables/
/workers/local-development/local-data/
/workers/local-development/
/workers/local-development/remote-data/

hyperlint-ai · 2025-06-05T20:13:00Z

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.

PR Change Summary

Draft documentation for connecting to remote resources during local development has been initiated, including guidelines for configuration and usage.

Started draft documentation for connecting to remote resources during local development.
Outlined configuration changes needed for different environments.
Introduced a new section on connecting to remote resources with examples.
Added a comparison guide for choosing between Wrangler and Vite.

Modified Files

src/content/docs/workers/local-development/index.mdx
src/content/docs/workers/local-development/local-data.mdx

Added Files

src/content/docs/workers/local-development/wrangler-vs-vite.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

github-actions · 2025-06-05T20:13:39Z

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern	Owners
`/public/__redirects`	`@GregBrimble`, `@KianNH`, `@pedrosousa`, `@WalshyDev`, `@cloudflare/pcx-technical-writing`
`/src/content/docs/cloudflare-for-platforms/workers-for-platforms/`	`@irvinebroque`, `@angelampcosta`, `@GregBrimble`, `@cloudflare/deploy-config`, `@cloudflare/pcx-technical-writing`
`/src/content/docs/d1/`	`@elithrar`, `@rozenmd`, `@vy-ton`, `@joshthoward`, `@oxyjun`, `@harshil1712`, `@cloudflare/pcx-technical-writing`
`/src/content/docs/durable-objects/`	`@elithrar`, `@vy-ton`, `@joshthoward`, `@oxyjun`, `@harshil1712`, `@mikenomitch`, `@cloudflare/pcx-technical-writing`, `@cloudflare/workers-runtime-1`
`/src/content/docs/pages/`	`@cloudflare/workers-docs`, `@GregBrimble`, `@WalshyDev`, `@aninibread`, `@irvinebroque`, `@cloudflare/pcx-technical-writing`, `@kodster28`
`/src/content/docs/workers/`	`@cloudflare/workers-docs`, `@GregBrimble`, `@irvinebroque`, `@mikenomitch`, `@WalshyDev`, `@cloudflare/deploy-config`, `@cloudflare/pcx-technical-writing`, `@kodster28`, `@cloudflare/wrangler`, `@cloudflare/workers-runtime-1`, `@cloudflare/wrangler`
`/src/content/docs/workers/observability/`	`@irvinebroque`, `@mikenomitch`, `@rohinlohe`, `@kodster28`, `@cloudflare/pcx-technical-writing`
`/src/content/docs/workers/static-assets`	`@irvinebroque`, `@GregBrimble`, `@WalshyDev`, `@kodster28`, `@cloudflare/deploy-config`, `@cloudflare/pcx-technical-writing`
`/src/content/docs/workers/wrangler/`	`@cloudflare/wrangler`, `@irvinebroque`, `@kodster28`, `@cloudflare/pcx-technical-writing`, `@cloudflare/workers-runtime-1`
`/src/content/partials/workers/`	`@cloudflare/workers-docs`, `@GregBrimble`, `@irvinebroque`, `@mikenomitch`, `@WalshyDev`, `@cloudflare/deploy-config`, `@cloudflare/pcx-technical-writing`, `@kodster28`, `@cloudflare/wrangler`, `@cloudflare/workers-runtime-1`, `@cloudflare/wrangler`

github-actions · 2025-06-05T20:15:41Z

Preview URL: https://4cd35739.preview.developers.cloudflare.com
Preview Branch URL: https://korinne-hybrid-dev.preview.developers.cloudflare.com

Files with changes (up to 15)

src/content/docs/workers/local-development/index.mdx

Co-authored-by: Pete Bacon Darwin <[email protected]>

src/content/partials/workers/bindings_per_env.mdx

...docs/cloudflare-for-platforms/workers-for-platforms/get-started/developing-with-wrangler.mdx

src/content/partials/workers/bindings_per_env.mdx

…s/get-started/developing-with-wrangler.mdx Co-authored-by: Dario Piotrowicz <[email protected]>

src/content/docs/workers/development-testing/wrangler-vs-vite.mdx

src/content/partials/workers/bindings_per_env.mdx

kodster28

Flagged the redirects that are needed.

kodster28 · 2025-06-18T16:38:11Z

src/content/partials/workers/bindings_per_env.mdx

-> ```
->
-> This command allows you to develop against remote resources and data stored on Cloudflare's network.
+## Local development


Depending on how many places this is pulled in, you should be careful with headings in partials.

public/__redirects

adds draft docs for connecting to remote resources during local dev (…

49c069b

…hybrid dev)

github-actions bot added the size/m label Jun 5, 2025

github-actions bot assigned GregBrimble Jun 5, 2025

github-actions bot added the product:workers Related to Workers product label Jun 5, 2025

github-actions bot assigned irvinebroque, kodster28, mikenomitch and WalshyDev Jun 5, 2025

This comment was marked as spam.

Sign in to view

dario-piotrowicz reviewed Jun 5, 2025

View reviewed changes

petebacondarwin reviewed Jun 6, 2025

View reviewed changes

This comment was marked as spam.

Sign in to view

korinne and others added 3 commits June 10, 2025 11:47

Update src/content/docs/workers/local-development/index.mdx

0da08bf

Co-authored-by: Pete Bacon Darwin <[email protected]>

Update src/content/docs/workers/local-development/index.mdx

475059f

Co-authored-by: Pete Bacon Darwin <[email protected]>

updates overview pages, bindings-per-env for new hybrid dev

3f9ab86

github-actions bot added size/l and removed size/m labels Jun 12, 2025

korinne marked this pull request as ready for review June 12, 2025 07:58

korinne requested review from GregBrimble, irvinebroque, mikenomitch, WalshyDev, kodster28 and a team as code owners June 12, 2025 07:58

korinne requested review from elithrar, vy-ton, joshthoward, Oxyjun, harshil1712 and rozenmd as code owners June 17, 2025 23:49

github-actions bot added product:cloudflare-for-platforms product:d1 D1: https://developers.cloudflare.com/d1/ product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ product:pages labels Jun 17, 2025

dario-piotrowicz mentioned this pull request Jun 18, 2025

add Hybrid development API section #23025

Closed

3 tasks

updates example config

f6de38a

dario-piotrowicz reviewed Jun 18, 2025

View reviewed changes

src/content/partials/workers/bindings_per_env.mdx Outdated Show resolved Hide resolved

penalosa approved these changes Jun 18, 2025

View reviewed changes

dario-piotrowicz reviewed Jun 18, 2025

View reviewed changes

korinne and others added 2 commits June 18, 2025 08:07

Update src/content/docs/cloudflare-for-platforms/workers-for-platform…

16ba2a9

…s/get-started/developing-with-wrangler.mdx Co-authored-by: Dario Piotrowicz <[email protected]>

Update src/content/docs/cloudflare-for-platforms/workers-for-platform…

faebe50

…s/get-started/developing-with-wrangler.mdx Co-authored-by: Dario Piotrowicz <[email protected]>

dario-piotrowicz reviewed Jun 18, 2025

View reviewed changes

src/content/docs/workers/development-testing/wrangler-vs-vite.mdx Show resolved Hide resolved

src/content/partials/workers/bindings_per_env.mdx Outdated Show resolved Hide resolved

lrapoport-cf mentioned this pull request Jun 18, 2025

Rename Mixed Mode to remote proxy/remote bindings depending on context cloudflare/workers-sdk#9586

Merged

12 tasks

korinne added 2 commits June 18, 2025 08:27

updates bindings comparison, small changes to wording

75426ea

updates redirects

520b5f2

korinne requested review from KianNH and pedrosousa as code owners June 18, 2025 15:38

KianNH approved these changes Jun 18, 2025

View reviewed changes

kodster28 requested changes Jun 18, 2025

View reviewed changes

korinne enabled auto-merge (squash) June 18, 2025 16:39

updates more redirects

4cd3573

kodster28 approved these changes Jun 18, 2025

View reviewed changes

korinne merged commit bd9932d into production Jun 18, 2025
10 checks passed

korinne deleted the korinne-hybrid-dev branch June 18, 2025 17:02

Adds draft docs for connecting to remote resources during local dev (hybrid dev) #22940

Adds draft docs for connecting to remote resources during local dev (hybrid dev) #22940

Uh oh!

Conversation

korinne commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

github-actions bot commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hyperlint-ai bot commented Jun 5, 2025

PR Change Summary

Uh oh!

github-actions bot commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as spam.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as spam.

This comment was marked as spam.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kodster28 left a comment

Choose a reason for hiding this comment

Uh oh!

kodster28 Jun 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

korinne commented Jun 5, 2025 •

edited

Loading

github-actions bot commented Jun 5, 2025 •

edited

Loading

github-actions bot commented Jun 5, 2025 •

edited

Loading

github-actions bot commented Jun 5, 2025 •

edited

Loading