Conversation
Co-authored-by: irvinebroque <irvinebroque@users.noreply.github.com>
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
|
/bonk the |
|
@kodster28 refs #28886 @MattieTK for review |
![ask-bonk[bot]](https://avatars.githubusercontent.com/in/2454580?s=60&v=4){kind=small}
There was a problem hiding this comment.
3 issues to address before merge.
HIGH: Reviewer request — move wrangler check to Workers page. @irvinebroque requested that the wrangler check command (currently at lines 213–241 of general.mdx) be moved to workers.mdx. This command profiles Worker startup — it belongs with the other Workers commands.
MEDIUM: 3 full URLs should be relative paths. workers.mdx contains https://developers.cloudflare.com/... links at lines 65, 171, and 351. Per the style guide, internal links must use relative paths. Posted inline suggestions below.
Note (out of scope): ~160 links across ~70 files point to /workers/wrangler/commands/#<anchor> (the index page) with anchors like #dev, #deploy, #secret, #tail, #types, #versions-deploy, etc. These anchors do not exist on the index page — the commands live on subpages. This is a pre-existing issue not introduced by this PR, but worth a follow-up to update those links to point to /workers/wrangler/commands/workers/#dev (or equivalent subpage).
| - Path(s) to [Wrangler configuration file](/workers/wrangler/configuration/). If not provided, Wrangler will use the nearest config file based on your current working directory. | ||
| - You can provide multiple configuration files to run multiple Workers in one dev session like this: `wrangler dev -c ./wrangler.toml -c ../other-worker/wrangler.toml`. The first config will be treated as the _primary_ Worker, which will be exposed over HTTP. The remaining config files will only be accessible via a service binding from the primary Worker. | ||
| - `--no-bundle` <Type text="boolean" /> <MetaInfo text="(default: false) optional" /> | ||
| - Skip Wrangler's build steps. Particularly useful when using custom builds. Refer to [Bundling](https://developers.cloudflare.com/workers/wrangler/bundling/) for more information. |
There was a problem hiding this comment.
Use a relative path for internal links:
| - Skip Wrangler's build steps. Particularly useful when using custom builds. Refer to [Bundling](https://developers.cloudflare.com/workers/wrangler/bundling/) for more information. | |
| - Skip Wrangler's build steps. Particularly useful when using custom builds. Refer to [Bundling](/workers/wrangler/bundling/) for more information. |
| - `--name` <Type text="string" /> <MetaInfo text="optional" /> | ||
| - Name of the Worker. | ||
| - `--no-bundle` <Type text="boolean" /> <MetaInfo text="(default: false) optional" /> | ||
| - Skip Wrangler's build steps. Particularly useful when using custom builds. Refer to [Bundling](https://developers.cloudflare.com/workers/wrangler/bundling/) for more information. |
There was a problem hiding this comment.
Same fix — relative path:
| - Skip Wrangler's build steps. Particularly useful when using custom builds. Refer to [Bundling](https://developers.cloudflare.com/workers/wrangler/bundling/) for more information. | |
| - Skip Wrangler's build steps. Particularly useful when using custom builds. Refer to [Bundling](/workers/wrangler/bundling/) for more information. |
| It may take up to 1 minute (60 seconds) for a tail to exit sampling mode after adding an option to filter tail messages. | ||
| ::: | ||
|
|
||
| If sampling persists after using options to filter messages, consider using [instant logs](https://developers.cloudflare.com/logs/instant-logs/). |
There was a problem hiding this comment.
Use a relative path:
| If sampling persists after using options to filter messages, consider using [instant logs](https://developers.cloudflare.com/logs/instant-logs/). | |
| If sampling persists after using options to filter messages, consider using [instant logs](/logs/instant-logs/). |
|
Review posted and fixes pushed. Here is what was done: Review posted on PR #28989 with 3 inline suggestions and a summary comment. Fixes committed (
Out-of-scope note included in the review: ~160 existing links across ~70 files point to |
MattieTK
left a comment
MattieTK
left a comment
There was a problem hiding this comment.
lgtm, I wonder if there's a nicer way to do this in the future with .md where we can split this document out a bit like a skill + resources dynamically.
But understand that the page weight is currently far too large even for users with actual browsers.
2 participants
Here is a summary of the changes made:
Changes
Problem
The Wrangler commands page at
/workers/wrangler/commands/made it hard to discover Workers-specific commands. All core Workers commands (dev,deploy,versions,rollback, etc.) were buried in a "General commands" page alongside unrelated utility commands likelogin,telemetry, andcomplete. Users searching for "Workers" on the page could not find where Workers commands lived.Solution
1. New file:
src/content/docs/workers/wrangler/commands/workers.mdxinit,dev,deploy,delete,setup,secret,tail,versions,triggers,deployments,rollback,types2. Updated:
src/content/docs/workers/wrangler/commands/general.mdxdocs,login,logout,auth,whoami,telemetry,check,complete3. Updated:
src/content/docs/workers/wrangler/commands/index.mdxwrangler dev,wrangler deploy,wrangler versions) so they are findable via Cmd+F<DirectoryListing />Sidebar result
The commands sidebar now shows:
No broken links
/workers/wrangler/commands/general/and it was a self-reference that is now correctly updated inworkers.mdxgeneral.mdxpage still exists at the same URL, so no external links to that page will 404npm run check(0 errors),npm run lint(clean)Closes #28987
github run