Add Wrangler v4 RC changelog entry #20355
Conversation
![hyperlint-ai[bot]](https://avatars.githubusercontent.com/in/718456?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hyperlint Review is complete!
Hyperlint Vale Style Guide Review
Reviewed 1 files and found 1 issues.
See the inline comments and suggestions below.
Hyperlint Link Check Review
Reviewed 1 files and found 0 issues.
We are upgrading our reviewer model! Going forward, our model will learn your particular style - which comments you all accept and reject, so that it can further personalize its suggestions.
What is Hyperlint?
Hyperlint is an AI agent that helps you write, edit, and maintain your documentation. It can review, edit, and suggest fixes for your documentation.
Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation.
|
Howdy and thanks for contributing to our repo. 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. |
Co-authored-by: lrapoport-cf <[email protected]> Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
|
|
||
| (think these need a — instead do x...) | ||
|
|
||
| - Arguments: |
There was a problem hiding this comment.
@lrapoport-cf @penalosa for the things below, I think if you work on Wrangler it's easy to look at this list and know "oh yeah these are all old things that there are other ways of doing" — but right now this comes across as a long list without guidance on what people can do instead.
Especially since we already have a lot of the deprecations and guidance here:
https://developers.cloudflare.com/workers/wrangler/deprecations/#wrangler-v3
...should we just update that page with the RC v4 stuff, and in this post, link directly to it?
I think it could help us tighten up the post, and also help send the reader to the page that will give them the relevant details they need
There was a problem hiding this comment.
I included the list for completeness, but we could actually remove a fair few—a lot of these were deprecated in v2 and have never worked in v2+
There was a problem hiding this comment.
strawman suggestion:
- keep any deprecations that are new, that we haven't communicated previously
- for the ones we have already talked about for v2 and v3, just say that things previously deprecated are now removed, and link to that deprecations page
- update the deprecations page with this list we have here so that it's concrete somewhere in dev docs
Sound good?
Then we can follow up and make the deprecations page slightly clearer
Think that would go a long way and then we're good here to ship this
There was a problem hiding this comment.
Sounds good, although maybe we shouldn't update the deprecation page at this point? Once v4 is released properly we'll have a full migration guide we can point people to, but that's not fully ready yet.
There was a problem hiding this comment.
I don't feel strongly about it though—happy to update that now if you think that makes sense.
There was a problem hiding this comment.
I've made this more user-focused in https://github.com/cloudflare/cloudflare-docs/pull/20355/commits/419f9c6a25f8e05f5041e4495d353cbccaec256a—how does that look?
There was a problem hiding this comment.
i left a couple really small comments, but overall looks good to me! agree with @irvinebroque we should update the deprecations page, for completeness
Co-authored-by: lrapoport-cf <[email protected]>
Co-authored-by: lrapoport-cf <[email protected]>
github-actions
bot
added
product:workers
There was a problem hiding this comment.
Hyperlint Review is complete!
Hyperlint Vale Style Guide Review
Reviewed 2 files and found 2 issues.
See the inline comments and suggestions below.
Hyperlint Link Check Review
Reviewed 2 files and found 0 issues.
We are upgrading our reviewer model! Going forward, our model will learn your particular style - which comments you all accept and reject, so that it can further personalize its suggestions.
What is Hyperlint?
Hyperlint is an AI agent that helps you write, edit, and maintain your documentation. It can review, edit, and suggest fixes for your documentation.
Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation.
|
|
||
| ### `--node-compat` and the `node_compat` config file property | ||
|
|
||
| Instead, use the [`nodejs_compat` compatibility flag](https://developers.cloudflare.com/workers/runtime-apis/nodejs). This includes the functionality from legacy `node_compat` polyfills and natively implemented Node.js APIs. |
There was a problem hiding this comment.
Identified issues
- Vale Style Guide - (cloudflare.LinkChecks-warning) Warning: When referring to another page in our docs, use the full relative link (
/1.1.1.1/check/) instead of the full URL (https://developers.cloudflare.com/1.1.1.1/check/) or a local development link (http://localhost:1111/1.1.1.1/check/).
Proposed fix
| Instead, use the [`nodejs_compat` compatibility flag](https://developers.cloudflare.com/workers/runtime-apis/nodejs). This includes the functionality from legacy `node_compat` polyfills and natively implemented Node.js APIs. | |
| Instead, use the [`nodejs_compat` compatibility flag](/workers/runtime-apis/nodejs). This includes the functionality from legacy `node_compat` polyfills and natively implemented Node.js APIs. |
The style guide recommends using a full relative link instead of a full URL when linking to another page in the documentation. I've replaced the full URL with a relative link to comply with this guideline.
| - `init` creates a project boilerplate. | ||
| - JSON bindings for `vars`. | ||
| - Local mode for `wrangler dev`. | ||
| - Module system (for both modules and service worker format Workers). |
There was a problem hiding this comment.
Identified issues
- Vale Style Guide - (Terms-error) Use 'Worker' instead of 'worker'.
Proposed fix
| - Module system (for both modules and service worker format Workers). | |
| - Module system (for both modules and service Worker format Workers). |
The term 'worker' should be capitalized to 'Worker' as per the style guide recommendation. This is a straightforward capitalization issue.
8 participants
Adds a changelog entry for the Wrangler v4 RC.