archesproject / arches-docs

official repo for Arches documentation
https://arches.readthedocs.io
9 stars 21 forks source link

Clarify node.js installation in Requirements/Dependencies page #275

Closed brubyx closed 1 year ago

brubyx commented 2 years ago

The Requirements/Dependencies page mentions node.js only as Yarn prerequisite for Windows users. When I tried to install Arches on Ubuntu, Yarn did not install node.js and I had to install it manually. https://arches.readthedocs.io/en/stable/requirements-and-dependencies/

ekansa commented 1 year ago

@brubyx I believe this issue is resolved. Do you think the current documentation on this topic looks OK? https://arches.readthedocs.io/en/stable/requirements-and-dependencies/?highlight=windows%20node.js#software-dependencies

brubyx commented 1 year ago

Thank you @ekansa, I still find it misleading. This is the remark I asked to clarify:

**Windows Use the .msi installer in the link above, but first install Node.js

Yarn do not install node.js also on other platforms but the remark seems to be specific for Windows installs.

ekansa commented 1 year ago

Thanks @brubyx ! Do you think something like this will be better?

"Please note: You will need to install Node.js prior to installing yarn on all platforms, not just Windows."

brubyx commented 1 year ago

In my opinion this is much clearer. Thank you @ekansa

ekansa commented 1 year ago

@brubyx I'm doing some more investigation of this, and it seems that there are a few complications here. The current documentation points to a stale method for installing Yarn (redirecting to here; https://classic.yarnpkg.com/en/docs/install#windows-stable). More current Yarn installation instructions say nothing specific to Windows: https://yarnpkg.com/getting-started/install

If I understand things correctly, Yarn installation currently works the same across different operating systems because it's all handled by the Node.js package manager. Do I have that correct?

ekansa commented 1 year ago

PS. This @brubyx here's my proposed revision: https://arches.readthedocs.io/en/node_yarn_7_3/requirements-and-dependencies/?highlight=node.js%20yarn#software-dependencies

chiatt commented 1 year ago

@ekansa I think your proposed solution really helps clarify the issue.

brubyx commented 1 year ago

@ekansa your revision is perfect. For Ubuntu the install script seems to take care of everything correctly and this is what I see on my server: $ yarn version check yarn version v1.22.19 $ node -v v16.17.1