Worker Previews docs: restructure resources, add recipes, update cross-references#31775
Open
yomna-shousha wants to merge 10 commits into
Open
Worker Previews docs: restructure resources, add recipes, update cross-references#31775yomna-shousha wants to merge 10 commits into
yomna-shousha wants to merge 10 commits into
Conversation
…s-references - Split resources.mdx into resources/ directory (index, bindings, durable-objects) - Add recipes.mdx with static how-tos (PR preview, staging, data isolation, monorepo, migration, API) - Move wrangler commands from previews/commands.mdx to wrangler/commands/workers.mdx - Add redirect for deleted commands page - Add PreviewsConfigDiagram and PreviewsResourcesDiagram components - Update cross-references across builds, version-urls, environments, compare-preview-workflows - Normalize 'Worker Previews' to 'Previews' in wrangler config, environments, migrate-from-pages - Delete troubleshooting.mdx (content folded into other pages) - Add custom domain screenshot image
yomna-shousha
requested review from
a team,
GregBrimble,
MattieTK,
WalshyDev,
aninibread,
ericclemmons,
irvinebroque,
kodster28,
korinne and
vy-ton
as code owners
Contributor
Review✅ No issues found in commit Code ReviewThis code review is in beta and may not always be helpful — use your judgment. No code review issues found. ConventionsChecks PR title, description, and redirect checklist. No convention issues found. Style Guide ReviewNo style-guide issues found. RedirectsNo missing redirect entries found. CommandsOnly codeowners can run commands. Post a comment with the command to trigger it.
|
Contributor
|
This PR changes current filenames or deletes current files. Make sure you have redirects set up to cover the following paths:
|
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
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:
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. |
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
… sidebar.order - Fix /workers/configuration/cloudflare-access/ → /cloudflare-one/policies/access/ - Rewrite compare-preview-workflows.mdx: replace 'review URLs' with 'Preview URLs' throughout, tighten tone to match previews docs - Add sidebar.order to compare-preview-workflows.mdx and version-urls.mdx
Contributor
- Fix Access link: /cloudflare-one/policies/access/ → /cloudflare-one/access-controls/policies/ - Fix placement link: /workers/configuration/smart-placement/ → /workers/configuration/placement/ - Add missing redirect for deleted /workers/previews/troubleshooting/
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
10 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 previewspreviews/resources/index.mdx— overview of resource sharing and isolationpreviews/resources/bindings.mdx— per-binding reference with config snippetspreviews/resources/durable-objects.mdx— DO and Containers isolation detailsNew components:
PreviewsConfigDiagram.astro— base configuration diagramPreviewsResourcesDiagram.astro— resource sharing diagramRestructured:
resources.mdxintoresources/directory (index, bindings, durable-objects)previews/commands.mdx→wrangler/commands/workers.mdxUpdated cross-references:
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)
Known issues to fix later
/workers/configuration/cloudflare-access/link in index.mdx needs correct path