Skip to content
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

Merged
merged 8 commits into from
May 2, 2024
2 changes: 2 additions & 0 deletions en/4x/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ redirect_from: "/4x/api.html"

<h1>4.x API</h1>

{% include note.html content="Express 4.0 requires Node.js 0.10 or higher." %}

{% include api/{{ page.lang }}/4x/express.md %}
{% include api/{{ page.lang }}/4x/app.md %}
{% include api/{{ page.lang }}/4x/req.md %}
Expand Down
2 changes: 2 additions & 0 deletions en/5x/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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." %}
Copy link
Member

@crandmck crandmck Apr 26, 2024

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @crandmck !

Change added here


{% include api/{{ page.lang }}/5x/express.md %}
{% include api/{{ page.lang }}/5x/app.md %}
{% include api/{{ page.lang }}/5x/req.md %}
Expand Down
7 changes: 7 additions & 0 deletions en/starter/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Copy link
Member

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @crandmck ! I'm not a native English speaker, so I welcome these language suggestions.

Change added here.


* [Express 4.x](/{{ page.lang }}/4x/api.html) requires Node.js 0.10 or higher.
* [Express 5.x](/{{ page.lang }}/5x/api.html) will require Node.js 18 or higher.

### [Previous: More examples ](/{{ page.lang }}/starter/examples.html)
4 changes: 4 additions & 0 deletions en/starter/installing.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ redirect_from: "/starter/installing.html"

Assuming you've already installed [Node.js](https://nodejs.org/), create a directory to hold your application, and make that your working directory.

<div class="doc-box doc-info" markdown="1">
Check the minimum required Node.js for each Express version [here](/{{ page.lang }}/starter/faq.html#which-is-the-minimum-version-of-nodejs-that-express-supports).
</div>

```console
$ mkdir myapp
$ cd myapp
Expand Down
Loading