Deployment: Add a note about PaaS default nodejs version #28720
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MaoShizhong
reviewed
Aug 30, 2024
nodeJS/express/deployment.md
Outdated
| @@ -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"> | |||
There was a problem hiding this comment.
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"> |
nodeJS/express/deployment.md
Outdated
| @@ -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"> | |||
|
|
|||
| 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. | |||
There was a problem hiding this comment.
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). |
MaoShizhong
approved these changes
Sep 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Because
depending on the host provider the student uses, the default version might not be the LTS version. Adding a note about this can help students avoid frustrating debugging sessions when using Nodejs features that are not supported by earlier versions.
This PR
Issue
Closes #28621
Additional Information
Pull Request Requirements
location of change: brief description of changeformat, e.g.Intro to HTML and CSS lesson: Fix link textBecausesection summarizes the reason for this PRThis PRsection has a bullet point list describing the changes in this PRIssuesection