Add intial documentation on dev.eessi.io
#321
Conversation
`dev.eessi.io` overview and instructions
Build page from dev branch
| `dev.eessi.io` is the development repository of EESSI. With it, developers can build and deploy non-production ready versions of their software to a CernVM-FS repository. | ||
| This way, development version can easily be tested on systems where `dev.eessi.io` is available. | ||
|
|
||
| On a system with `dev.eessi.io` mounted access is possible with `module use /cvmfs/dev.eessi.io/versions/2023.06/modules/all`. Then, all that is left is |
There was a problem hiding this comment.
This will change when we use subdirectories for projects
There was a problem hiding this comment.
In fact, we probably (eventually) want a small custom init script for dev.eessi.io which:
- prints a warning (something like "
installations indev.eessi.ioare not for production use, only for testing"); - sets up the environment for
software.eessi.io; - sets up the environment for a specific (set of) projects in
dev.eessi.io;
|
|
||
| ## Adding software | ||
|
|
||
| Using `dev.eessi.io` is similar to using EESSI's production repository `software.eessi.io`. Software builds are triggered by a bot listening to pull requests in GitHub repository (at the moment https://github.com/EESSI/dev.eessi.io). This repository is organised by project, where corresponding easystack files and easyconfig files are placed. |
There was a problem hiding this comment.
We'll probably ends up with separate repos per project, so point to https://github.com/search?q=org%3AEESSI+dev.eessi.io&type=repositories ?
|
|
||
| Once a build is complete and the `bot:deploy` label is added, a staging PR can be merged to deploy the | ||
| application to the `dev.eessi.io` cvmfs repository. On a system with `dev.eessi.io` mounted, then all | ||
| that is left is to `module use /cvmfs/dev.eessi.io/versions/2023.06/modules/all` and try out the software! |
There was a problem hiding this comment.
module use needs project subdir
There was a problem hiding this comment.
I'd rather wait until we implement this to change the docs (maybe we can merge the PR after that is done) so we can showcase the current state this next week. :)
This way we can already show working installations and I'm afraid if I try to change the subdirs on Monday I end up messing up 😅 What do you think?
There was a problem hiding this comment.
OK, let's not wait for the project subdirectories
Co-authored-by: Kenneth Hoste <kenneth.hoste@ugent.be>
Co-authored-by: Kenneth Hoste <kenneth.hoste@ugent.be>
Co-authored-by: Kenneth Hoste <kenneth.hoste@ugent.be>
Co-authored-by: Kenneth Hoste <kenneth.hoste@ugent.be>
Still todo: changes reflecting that cvmfs path includes project specific directory
|
|
||
| Once a build is complete and the `bot:deploy` label is added, a staging PR can be merged to deploy the | ||
| application to the `dev.eessi.io` cvmfs repository. On a system with `dev.eessi.io` mounted, then all | ||
| that is left is to `module use /cvmfs/dev.eessi.io/versions/2023.06/modules/all` and try out the software! |
There was a problem hiding this comment.
OK, let's not wait for the project subdirectories
This PR adds information on the
dev.eessi.ioCVMFS repository and basic usage wrt building and deploying software todev.eessi.io.This information will likely change in the future as the repo matures, but this should already provide a brief overview of the basic functionality.