-
Notifications
You must be signed in to change notification settings - Fork 5.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Promote Node.js compat #16918
Promote Node.js compat #16918
Conversation
Deploying cloudflare-docs with Cloudflare Pages
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a nit.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One additional thought... is promoting this page also generally important for the Framework guides / Get started info? Or only w/in the context of functions?
I imagine you've chatted and have more context on this, so feel free to ignore :)
@@ -45,7 +45,7 @@ Refer to [Routing](/pages/functions/routing/) for more information on route cust | |||
|
|||
### Runtime features | |||
|
|||
Workers runtime features, including compatibility with a subset of Node.js APIs and setting a [compatibility date or compatibility flag](/workers/configuration/compatibility-dates/) are configurable on Pages Functions. | |||
[Workers runtime features](workers/runtime-apis/#_top) are configurable on Pages Functions, including [compatibility with a subset of Node.js APIs](/workers/runtime-apis/nodejs). | |||
|
|||
Set these configurations by passing an argument to your [Wrangler](/workers/wrangler/commands/#dev-1) command or by setting them in the dashboard. To set Pages compatibility flags in the Cloudflare dashboard: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Might need to keep the info on the compat flags though.... I suppose I don't know the relative importance of nodejs compat vs compat dates in the functions onboarding experience.
Might be a question for @dario-piotrowicz?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When I spoke to Sam, these were the pages he recommended, but if anyone who is reviewing has additional thoughts on where promoting would be helpful, feel free to make suggestions.
I'd note that it's also already mentioned in the intro of https://developers.cloudflare.com/workers/runtime-apis/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Compat flags still necessary here, and I don't see them mentioned in the intro of https://developers.cloudflare.com/workers/runtime-apis/ ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@irvinebroque Sorry about that. I originally removed it because the sentence didn't link to the Node compat page (which was the origin of this request) and I didn't realize it needed both. I added the link to the compat date/flag page back and I added the compat date/flag link to the mention at https://developers.cloudflare.com/workers/runtime-apis/ as well.
Co-authored-by: Kody Jackson <[email protected]>
Update: Following up with assignees on approving this one via Chat. |
@irvinebroque I updated this PR per your comment. Please review and approve when you have a chance. Thanks! |
* Add/Edit two lines to promote Node.js compat * Apply suggestions from code review Co-authored-by: Kody Jackson <[email protected]> * Updated all with compat date and flag --------- Co-authored-by: Kody Jackson <[email protected]>
* Add/Edit two lines to promote Node.js compat * Apply suggestions from code review Co-authored-by: Kody Jackson <[email protected]> * Updated all with compat date and flag --------- Co-authored-by: Kody Jackson <[email protected]>
Summary
I'm still learning about these products so please feel free to edit what I wrote if it doesn't make sense or isn't addressing the request.