netmaker icon indicating copy to clipboard operation
netmaker copied to clipboard

[Bug]: documentation error - Install without Docker secrtion

Open bmullan opened this issue 2 years ago • 3 comments

Contact Details

[email protected]

What happened?

Documentation says:

curl -sfL https://raw.githubusercontent.com/gravitl/netmaker/master/scripts/netmaker-server.sh

should be:

curl -sfL https://raw.githubusercontent.com/gravitl/netmaker/tree/master/scripts/netmaker-server.sh

Version

v0.14.5

What OS are you using?

Linux

Relevant log output

No response

Contributing guidelines

  • [X] Yes, I did.

bmullan avatar Jul 20 '22 21:07 bmullan

After working on this for a bit I think there are several documentation errors in the section:

https://docs.netmaker.org/server-installation.html#linux-install-without-docker

This command also fails to find a file:

sudo wget -O /usr/share/nginx/html/netmaker-ui.zip https://github.com/gravitl/netmaker-ui/releases/download/latest/netmaker-ui.zip

Has anyone verified the commands listed?

thanks brian

bmullan avatar Jul 20 '22 21:07 bmullan

I am guessing that the last time there were verified was probably around version 0.9.x or 0.10.x.

Everyone seems to be using docker so keeping that section of the documents up to date does not merit high priority.

mattkasun avatar Jul 20 '22 21:07 mattkasun

Everyone seems to be using docker so keeping that section of the documents up to date does not merit high priority

Maybe there's a little bit of a chicken vs egg situation going on here? The project members and interested parties favor Docker so the Docker documentation is maintained and Docker installs work better. Non-Docker documentation is way out of date and under-maintained, so anyone attempting an install directly onto the OS immediately experiences pain and frustration, so tries again with the Docker install which works ...

:-)

terrytriplett avatar Jul 20 '22 22:07 terrytriplett

Non-docker instructions were updated a few weeks ago, so I'm closing this for now. Check them out here: https://docs.netmaker.org/server-installation.html#linux-install-without-docker

afeiszli avatar Sep 22 '22 11:09 afeiszli

Oh well thanks anyway. The errors I saw just seemed related to NOT having the right "paths" to files in the 2 command examples ?

That to me shouldn't seem to take a lot of maintainer time to correct...

Especially if you know your GitHub repository's layout !

Docker isn't a good option for everybody.

Brian

On Wed, Jul 20, 2022, 6:50 PM terrytriplett @.***> wrote:

Everyone seems to be using docker so keeping that section of the documents up to date does not merit high priority

Maybe there's a little bit of a chicken vs egg situation going on here? The project members and interested parties favor Docker so the Docker documentation is maintained and Docker installs work better. Non-Docker documentation is way out of date and under-maintained, so anyone attempting an install directly onto the OS immediately experiences pain and frustration, so tries again with the Docker install which works ...

:-)

— Reply to this email directly, view it on GitHub https://github.com/gravitl/netmaker/issues/1403#issuecomment-1190844509, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAM23J33C7PRPGE564NEIETVVB7CXANCNFSM54FGDMVQ . You are receiving this because you authored the thread.Message ID: @.***>

bmullan avatar Oct 11 '22 07:10 bmullan