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

Doc: update installation of NodeJS, add paths for NMEA sample files + cosmetics #1648

Merged
merged 9 commits into from
Nov 12, 2023
Merged

Conversation

MatsA
Copy link
Contributor

@MatsA MatsA commented Oct 14, 2023

No description provided.

@KEGustafsson
Copy link
Contributor

KEGustafsson commented Oct 14, 2023

Good to know that node installation scripts are nowadays deprecated, this has impact to docker images too.

Copy link
Member

@tkurki tkurki left a comment

Choose a reason for hiding this comment

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

Why add the commands to find the paths of the sample files? Why would an end user need to find the paths? There are no instructions what the end user should do with the paths.

@MatsA
Copy link
Contributor Author

MatsA commented Oct 16, 2023

Did a fresh install of the SK server and used the new documentation to check.

What I missed at the end, after running the setup script and adding the admin account, was information about how to use the sample files. It's very nice to use the sample files to be acquainted with the functions of SK.

So below the heading "Set up data connections" I thought that the info for the paths was appropriate. The paths to the files have changed during different versions of the SK server so instead of a fixed path to the file I used the command to find the file.

@tkurki
Copy link
Member

tkurki commented Oct 16, 2023

@MatsA
Copy link
Contributor Author

MatsA commented Oct 16, 2023

Absolutely it's documented how to use it from command line. The first 2 ways will threw some confusing errors IF you have run the setup script since one instance of the SK server is already running... Of course you could stop the running SK server but will a newbie understand that ?

The 3:d way is as said command line.

The above could be a little confusing for a newbie which I think is addressed in these pages of documentation.

When I'm testing things, NodeRed, new plugins and so on, I'm using sample files on a test server at home. Most often I'm using own recorded files but sometimes the mentioned sample files delivered with SK.

I thought this use case could be appropriate for other users starting up/using SK. It was also mentioned in the old documentation.

But as usual, no big deal just trying to help.

@tkurki
Copy link
Member

tkurki commented Oct 16, 2023

I really appreciate your contributions! Don’t get me weong.

I just don’t see how an end user would benefit from knowing the path to the sample files, with no additional instructions what to do with the path.

@MatsA
Copy link
Contributor Author

MatsA commented Oct 17, 2023

Ok, you got a point ..... Will do an update later on.

@tkurki
Copy link
Member

tkurki commented Nov 2, 2023

I'd like to get this updated & merged, please.

@tkurki tkurki added the doc label Nov 2, 2023
MatsA added 4 commits November 2, 2023 22:25
Added information on how to use sample files
Settings for a NMEA 2000 file as input
Settings for a NMEA 2000 file as input
@MatsA
Copy link
Contributor Author

MatsA commented Nov 2, 2023

My sincere apologies for the delay !

@tkurki tkurki changed the title Updated installation of NodeJS and added paths for NMEA sample files + cosmetics Doc: updated installation of NodeJS, add paths for NMEA sample files + cosmetics Nov 12, 2023
@tkurki tkurki merged commit 52dfd57 into SignalK:master Nov 12, 2023
3 of 4 checks passed
@tkurki
Copy link
Member

tkurki commented Nov 12, 2023

Thanks! Now the docs document the use of FileStream connection type, that people regularly ask about.

@tkurki tkurki changed the title Doc: updated installation of NodeJS, add paths for NMEA sample files + cosmetics Doc: update installation of NodeJS, add paths for NMEA sample files + cosmetics Nov 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants