Skip to content

Worker Previews docs: restructure resources, update cross-references - #31775

Merged
yomna-shousha merged 35 commits into
productionfrom
worker-previews-docs-2
Sep 22, 2026
Merged

yomna-shousha merged 35 commits into
productionfrom
worker-previews-docs-2

Conversation

@yomna-shousha

@yomna-shousha yomna-shousha commented Jun 29, 2026 •

Copy link
Copy Markdown
Contributor

What this PR does

Restructures and expands the Worker Previews documentation.

Changes

New pages:

  • previews/recipes.mdx — static how-tos: PR preview per branch, persistent staging, data isolation, monorepo, migration from Wrangler environments, API-managed previews
  • previews/resources/index.mdx — overview of resource sharing and isolation
  • previews/resources/bindings.mdx — per-binding reference with config snippets
  • previews/resources/durable-objects.mdx — DO and Containers isolation details

New components:

  • PreviewsConfigDiagram.astro — base configuration diagram
  • PreviewsResourcesDiagram.astro — resource sharing diagram
  • Custom domain screenshot image

Restructured:

  • Split resources.mdx into resources/ directory (index, bindings, durable-objects)
  • Moved wrangler preview commands from previews/commands.mdx → wrangler/commands/workers.mdx
  • Added redirect for deleted commands page

Updated cross-references:

  • builds/index, build-branches, configuration, api-reference
  • version-urls, versions-and-deployments, compare-preview-workflows
  • wrangler/configuration, wrangler/environments
  • migrate-from-pages

Deleted:

  • commands.mdx (content moved to wrangler commands)
  • resources.mdx (split into resources/ directory)
  • troubleshooting.mdx (content folded into other pages)

Normalized: "Worker Previews" → "Previews" across referenced pages

Not included (separate commits)

  • Service bindings cross-Preview design page
  • Interactive recipe builder component (WorkerPreviewsRecipeBuilder)

Known issues to fix later

  • /workers/configuration/cloudflare-access/ link in index.mdx needs correct path

@cloudflare-docs-bot

This comment was marked as outdated.

@github-actions github-actions Bot added product:workers Related to Workers product size/xl labels Jun 29, 2026
@github-actions

github-actions Bot commented Jun 29, 2026 •

Copy link
Copy Markdown
Contributor

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

  • /workers/versions-and-deployments/preview-urls/

@github-actions

github-actions Bot commented Jun 29, 2026 •

Copy link
Copy Markdown
Contributor

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

Pattern Owners
/public/__redirects @cloudflare/content-engineering, @cloudflare/product-owners
/src/assets/images/workers/ @cloudflare/workers-docs, @GregBrimble, @irvinebroque, @WalshyDev, @cloudflare/deploy-config, @cloudflare/product-owners, @cloudflare/wrangler, @MattieTK, @vy-ton, @cloudflare/workers-runtime-1
*.ts @cloudflare/content-engineering, @kodster28
*.astro @cloudflare/content-engineering, @kodster28
/src/content/docs/containers/ @mikenomitch, @th0m, @cloudflare/product-owners, @cloudflare/cloudchamber
/src/content/docs/durable-objects/ @rita3ko, @irvinebroque, @vy-ton, @iglesiasbrandon, @joshthoward, @danlapid, @lambrospetrou, @mikenomitch, @cloudflare/product-owners
/src/content/docs/sandbox/ @cloudflare/product-owners, @cloudflare/ai-agents
/src/content/docs/workers/ @cloudflare/workers-docs, @GregBrimble, @irvinebroque, @mikenomitch, @korinne, @WalshyDev, @cloudflare/deploy-config, @cloudflare/product-owners, @cloudflare/wrangler, @MattieTK, @cloudflare/dev-plat-leads, @vy-ton, @cloudflare/workers-runtime-1
/src/content/docs/workers/ci-cd/builds/ @irvinebroque, @aninibread, @GregBrimble, @ericclemmons, @cloudflare/product-owners, @yomna-shousha, @MattieTK, @vy-ton, @scottbuscemi
/src/content/docs/workers/static-assets @irvinebroque, @GregBrimble, @WalshyDev, @cloudflare/deploy-config, @cloudflare/product-owners, @MattieTK, @vy-ton
/src/content/docs/workers/wrangler/ @cloudflare/wrangler, @irvinebroque, @cloudflare/product-owners, @MattieTK, @vy-ton

@ask-bonk

ask-bonk Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

I have completed my review of PR #31775. My findings are summarized above in the review. Here's a quick recap of what needs maintainer attention:

  • Broken link in previews/index.mdx to /workers/configuration/cloudflare-access/ — should be /cloudflare-one/access-controls/policies/
  • "WIP" in page title on previews/recipes.mdx — should be removed before merging to production
  • Missing sidebar.order on compare-preview-workflows.mdx and version-urls.mdx — may affect sidebar placement

Everything else looks solid: redirects are in place, MDX syntax is clean, component imports and image paths are correct, and the cross-reference updates are comprehensive.

github run

@github-actions

This comment was marked as outdated.

Comment thread src/components.ts Outdated
Co-authored-by: mvvmm <mvvmm@users.noreply.github.com>
@ask-bonk

ask-bonk Bot commented Sep 18, 2026

Copy link
Copy Markdown
Contributor

Agreed — these five components are page-specific (each used on exactly one page), so they belong as direct imports, not in the ~/components barrel.

The repo's documented convention (.agents/references/components.md:3, style-guide.md:280) is explicit: reusable components go in the barrel; page-specific wrapper components or one-off components may use deep paths instead of adding to the barrel.

Changes made:

  • Removed the five Previews*/WorkerPreviews* exports from src/components.ts:72-76
  • Switched imports to direct paths in previews/index.mdx (WorkerPreviewsDiagram), configuration.mdx (PreviewsConfigDiagram), resources/index.mdx (PreviewsResourcesDiagram, PreviewsDOCarouselDiagram), and get-started.mdx (WorkerPreviewsAgentPrompt); shared components (WranglerConfig, DashButton, Steps, Tabs) stay on the barrel import

Validation: pnpm run check passes (0 errors/warnings/hints), and prettier --check on components.ts passes.

github run

@yomna-shousha
yomna-shousha merged commit 23227aa into production Sep 22, 2026
14 checks passed
@yomna-shousha
yomna-shousha deleted the worker-previews-docs-2 branch September 22, 2026 11:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:containers product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ product:sandbox product:workers Related to Workers product size/xl

Projects

None yet

Development

Successfully merging this pull request may close these issues.