You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Reading over docs and #5730, seems like line 109 should say "NODE_VERSION: 16.13." Or if there are actually two NODE_VERSION environment variables, and the first one mentioned is fine being <16, it should at least be "NODE_VERSION: 14.18", as that is the lowest version supported by Astro.
requires a newer node version >14.0.0 [...] add NODE_VERSION = v16.7.0
"requires a newer node version >14.0.0" needs a small grammar tweak, like "requires a newer Node version (>14.0.0)" or "requires Node >14.0.0".
Jumps from saying it requires >14 to saying to use v16.7.0 with no explanation. Guessing it should say "NODE_VERSION = 14", but if it needs v16 to support Workers, then it should say "NODE_VERSION = 16.13," 16.7 is too old for Workers.
requires a newer node version >14.0.0 [...] add NODE_VERSION = v16.7.0
"requires a newer node version >14.0.0" needs a small grammar tweak, like "requires a newer Node version (>14.0.0)" or "requires Node >14.0.0".
Jumps from saying it requires >14.0.0 to saying to use v16.7.0 with no explanation. Should probably say "NODE_VERSION = 14", but if it needs v16 to support Workers, then it should say "NODE_VERSION = 16.13", 16.7 is too old for Workers.
Line 192, "16.7.0" --> "16.13.0", so the two versions match, and so they both meet current Wrangler requirements.
To find many of the above (in VS Code), I used: \bnode(\d[\d\.]*|[^s\d][^\d]*?(v?\d[\d\.]*))
files to include: *.md
Could be helpful to draw a clearer distinction between:
Static site built with Pages: >= v12.18, < v18.
SSR rendering or Functions (Workers): >= v16.13.
And maybe just recommend using >= v16.13 whenever possible, to avoid having to be aware of this "boundary".
Might be useful to review when Node versions are prefixed with "v" (and when they are not) in documentation & in code samples, and make sure it's consistent, and maybe explain when to use which, and when they are interchangeable. Not that I expect these docs to cover all the different places that are touched on, but at least make sure it's clear for the places that are somewhat Cloudflare-specific (like setting the NODE_VERSION environment variable using your UI).
Which Cloudflare product(s) does this pertain to?
Pages, Workers
Existing documentation URL(s)
Overview of Node requirements (as far as I can gather)
Wrangler:
v16.13.0
https://developers.cloudflare.com/workers/wrangler/get-started/(also:
wrangler@2.1.5
:>=16.13.0
: https://github.com/cloudflare/wrangler2)Miniflare:
v16.13.0
https://miniflare.dev/get-started/cli#installationCloudflare Workers Types:
^16.6.1
https://github.com/cloudflare/workers-types(should probably be
^16.13.0
)Cloudflare Pages: defaults to v12.18.0, supports "Any version up to 17.x": https://developers.cloudflare.com/pages/platform/build-configuration/#language-support-and-tools
Issues with docs
pages/framework-guides/astro (github, website)
L109:
L117:
Reading over docs and #5730, seems like line 109 should say "
NODE_VERSION: 16.13
." Or if there are actually twoNODE_VERSION
environment variables, and the first one mentioned is fine being <16, it should at least be "NODE_VERSION: 14.18
", as that is the lowest version supported by Astro.pages/framework-guides/deploy-a-qwik-site (github, website)
L61:
NODE_VERSION = 14
", but if it needs v16 to support Workers, then it should say "NODE_VERSION = 16.13
,"16.7
is too old for Workers.pages/framework-guides/deploy-a-svelte-site (github, website)
L65:
L73:
L171:
16.9
" on lines 65, 73 & 171.16.14
(PR).pages/framework-guides/remix (github, website)
L62:
NODE_VERSION = 14
", but if it needs v16 to support Workers, then it should say "NODE_VERSION = 16.13
",16.7
is too old for Workers.pages/how-to/use-direct-upload-with-continuous-integration (github, website)
L131:
L146:
Line 146 should say "
cimg/node:18.7.0
" to match line 131 (or vice versa).L150:
16.13.0
or later, v16.7.0 is too old.L176:
L192:
"18.0.0"
" --> ""16.13.0"
", as Wrangler requires16.13.0
or later.16.7.0
" --> "16.13.0
", so the two versions match, and so they both meet current Wrangler requirements.To find many of the above (in VS Code), I used:
\bnode(\d[\d\.]*|[^s\d][^\d]*?(v?\d[\d\.]*))
files to include:
*.md
Could be helpful to draw a clearer distinction between:
And maybe just recommend using >= v16.13 whenever possible, to avoid having to be aware of this "boundary".
Might be useful to review when Node versions are prefixed with "v" (and when they are not) in documentation & in code samples, and make sure it's consistent, and maybe explain when to use which, and when they are interchangeable. Not that I expect these docs to cover all the different places that are touched on, but at least make sure it's clear for the places that are somewhat Cloudflare-specific (like setting the
NODE_VERSION
environment variable using your UI).Node.js doesn't use "v" when talking about versions:
https://github.com/nodejs/release#release-schedule
... But does when tagging releases:
https://github.com/nodejs/node/tags
Feel free to edit this to include a task list.
PS: Sorry for breaking out of the issue template!
The text was updated successfully, but these errors were encountered: