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.

Sign up for GitHub

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

Deployment: Add a note about PaaS default nodejs version #28720

Merged
merged 3 commits into from
Sep 3, 2024
Merged

Deployment: Add a note about PaaS default nodejs version #28720

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
290bdaf
docs: note host provider default node version
Crn0 Aug 30, 2024
24e8a47
docs: reword note and change words
Crn0 Sep 2, 2024
bb53b78
Merge branch 'main' into patch_docs02
Crn0 Sep 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions nodeJS/express/deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,12 @@ In most cases, you'll be running into errors that thousands of developers have e

There are two stages of the deployment process where you are most likely to encounter problems. These are during deployment and right after.

<div class="lesson-note" markdown="1">
Copy link
Contributor

Choose a reason for hiding this comment

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

Note to self: Look into making warning note boxes more visually distinct from standard note boxes.

Suggested change
<div class="lesson-note" markdown="1">
<div class="lesson-note lesson-note--warning" markdown="1">


Depending on the host provider you use, the default NodeJs engine version might not be the LTS version. Additionally, depending on the NodeJs features you’re using, you might need to specify the NodeJs version to utilize those features.
Copy link
Contributor

Choose a reason for hiding this comment

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

General suggestions for wording of the point, plus a nice link to how to actually specify compatible versions.

Plus, instead of "NodeJs" or "NodeJS", it should either be "Node.js" or just "Node" for consistency across documentation I think. I don't mind either and have used "Node" in the suggestion below. Whatever we end up using, would you mind also amending any other mentions of "NodeJS" in the lesson if there are any?

Suggested change
Depending on the host provider you use, the default NodeJs engine version might not be the LTS version. Additionally, depending on the NodeJs features you’re using, you might need to specify the NodeJs version to utilize those features.
#### Node version compatibility
Depending on the host provider you use, the supported Node versions and default selected version may differ. You can refer to the providers' documentation for more information on what is supported and selected, and depending on what features you use in your code, you may need to [specify what Node versions your project is compatible with in your `package.json`](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#engines).


</div>

#### On deployment

If you run into an error while deploying, the first thing to do is to check the build logs. Finding the build logs should be easy; it's the stream of output you'll see after kicking off a new deployment.
Expand Down
Loading