Re-organise contributor page for development environment

[brucellino]

Re-organise development environment page

In order to contribute anything, you likely need the dev env working. I hold that this should be on a single page.

In the page https://docs.egi.eu/about/contributing/git/#installing-dependencies there is mention of installing NodeJS as a dependency. I propose suggesting the use of NVM.sh for contributors to manage various Node versions:

➜ nvm use 12                        
Now using node v12.22.0 (npm v6.14.11)                    /2.5s

08:49:23 in egi-documentation on  main [!?] took 2.5s 
➜ nvm use 20
Now using node v20.11.0 (npm v10.2.4)

NVM.sh is just a shell script which can be added using the curl - | bash method, and provides functionality similar to python's virtual environments.

Further, it's stated that NodeJS 12 should be used in the environment, but this is not declared anywhere. We should add it to package.json

{
  "engines": {
    "node": "12"
  }
}

Finally, if we merge #636 we will obviate the need for many of the local tests reproducing the checks run in the actions CI checks, since they will be taken care of by the pre-commit framework. For now, I propose keeping the existing documentation, but instructing contributors to install the pre-commit hooks when contributing.

Summary of proposed changes

I propose:

1. Create a specific page for setting up the development environment
   1. Propose use of NVM for Node
   2. Explain how to install pre-commit hooks
2. Declare dependencies explicitly

[sebastian-luna-valero]

Today I just came across https://github.com/flox/flox which may also help us keep a consistent environment throughout.

[brucellino]

This actually looks like a really good idea. I was going to suggest using asdf instead, but I was convinced by this comment in the Elixr forum. Coming from the Nix world, and assuming the project will be stable long term, it looks like a good approach.

[gwarf]

As #668 got merged, can/should this issue be closed?

[sebastian-luna-valero]

Please note that in the flox environment in #668 we only pinned the version of hugo. Do we want to pin other deps as well (e.g. nodejs)?

[gwarf]

Please note that in the flox environment in #668 we only pinned the version of hugo. Do we want to pin other deps as well (e.g. nodejs)?

For the record, the version somewhat pinned in the GitHub actions is pretty vague: https://github.com/EGI-Federation/documentation/blob/main/.github/workflows/build.yml#L32-L35