doc: clarify node compatibility issues and messages during raspberry … #1855
Conversation
…pi install I wasted a lot of time trying to make sure i had the current node installed. I think these mods clarify things for other users
|
|
||
| # Compatability messages displayed | ||
|
|
||
| When running 'signalk-server --sample-nmea0183-data' or in journalctl or system messages, you may see a message similar to the following. You can ignore this message if your version of Node is greater than or equal 18. Signal K server does support Node greater than version 20 |
There was a problem hiding this comment.
The log message was written as it stands on purpose: we have a range of versions that are known to work and as such are recommended versions. Previously we have had issues with people running the very latest node version and running into issues. While we may be able to say today that greater than version 20 is ok this may change tomorrow when a new version Node comes out.
It does not really make sense to output a log message saying one thing and then have some separate, unlinked documentation explaining that you can ignore the log message.
We are starting to work on upgraging the recommended Node versions, so I think we can address this issue then: update the log message with the known good version range and not refer to upgrade instructions if you are running a newer node version.
|
|
||
| # Node library incompatablities | ||
|
|
||
| When you install Signal K server, you may notice these messages being shown as part of the install. These are known issues. |
There was a problem hiding this comment.
The problem with this wording is that the list of known issues will for sure change over time and nobody will sync this list with the latest deprecation warnings.
The issue you are addressing is real and people regularly ask about it. I think a better solution would be to add a note in the installation instructions that Install process outputs some WARN messages that you can usually ignore. A separate document will probably not be noticed by most users.
|
|
||
| You may also get this message which is a known issue | ||
| ``` | ||
| (node:3545) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead. |
There was a problem hiding this comment.
This is a side effect of using a Node version newer than the recommended range. I would rather fix the issue, that we should do anyway sooner or later, and extend our recommended version range than add documentation that will get outdated on what exact warnings are safe to ignore.
…pi install
I wasted a lot of time trying to make sure i had the current node installed. I think these mods clarify things for other users