-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
docs: add minimum nodejs version in docs #1495
docs: add minimum nodejs version in docs #1495
Conversation
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.
LGTM! BTW this is related to expressjs/express#5595
Thanks for taking this on @inigomarquinez ! This is long overdue IMO... It will also close #1478. However, I would ask that you make some changes. Rather than put the information in an FAQ, it should be stated right up front in "Installing".... So instead of
Just put the text you have in the FAQ now into "Installing". This is more direct, since the reader doesn't have to click the link, and the Node version is really a prerequisite so the reader needs to know it right up front. Since this has been missing from the docs for so long, you can leave the FAQ for now. Otherwise, I would say it wouldn't be needed if you put it "Installing". I have a couple other specific comments, as well, which I'll put inline. |
en/5x/api.md
Outdated
@@ -11,6 +11,8 @@ redirect_from: "/5x/api.html" | |||
|
|||
{% include note.html content="This is early beta documentation that may be incomplete and is still under development." %} | |||
|
|||
{% include note.html content="Express 5.0 will require Node.js 18 or higher." %} |
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.
"Express 5.0 requires..."
Since 5.x is available now (in beta) it should be present tense.
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.
en/starter/faq.md
Outdated
@@ -90,4 +90,11 @@ If you have a specific file, use the `res.sendFile()` function. | |||
If you are serving many assets from a directory, use the `express.static()` | |||
middleware function. | |||
|
|||
<a name="which-is-the-minimum-version-of-nodejs-that-express-supports"></a> | |||
|
|||
## Which is the minimum version of Node.js that Express supports? |
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.
"What version of Node.js does Express require?"
Elsewhere you use "require" instead of "support", which is preferable IMO.
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.
Thanks @crandmck ! I've pushed some new commits with your suggestions! It now looks this way |
Thanks @inigomarquinez !! |
The purpose of this PR is to update the documentation to indicate the minimum nodejs version required for each express version, as required here.
I have added this information:
Warning
Please note that I have only made the change for the English version, as I don't know how translations of content into other languages are handled.