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

Simplify documentation #123

Open
dirkpetersen opened this issue Nov 12, 2023 · 1 comment
Open

Simplify documentation #123

dirkpetersen opened this issue Nov 12, 2023 · 1 comment

Comments

@dirkpetersen
Copy link

I think the general rule for the docs should be: Don't scare people into thinking this is too complex

As a reader with an above average attention span (there there people that are better than me but more that are worse) I would recommend to hide any complexity of EESSI in the documentation and basically have 3 main entry points:

  1. Using EESSI by persona
    1.1 Sysadmin (person with root): install packages and source the stuff in /etc/profiles.d
    1.2. User: ask sysadmin to install packages and source yourself and/or put it in your profile

  2. contributing to EESSI : https://www.eessi.io/docs/adding_software/opening_pr/

  3. Want to know more (background info, policies, slurm clusters, etc ..... most things that people never read. Those also should be de-prioritized in the mkdocs-material searches so not confuse people

  • I find this quote explains it all:
    "What if there was a way to avoid having to install a broad range of scientific software from scratch on every HPC cluster or cloud instance you use or maintain, without compromising on performance?"

  • The concept of easystack yaml files is probably a good idea but an entirely new concept to very infrequent users like me (just read about it today) . Is there not a way to autogenerate a yaml file in eb with default settings if i want to just submit a single easyconfig?

@xinan1911
Copy link
Collaborator

@dirkpetersen
Thanks for opening this issue and giving your feedback to EESSI docs. We have recently made some changes to the EESSI documentation which may address your recommendations.
We have added a list of quick links in the EESSI front page https://www.eessi.io/docs/. You can find frequently used links for users, system administrators and contributors.
If you want to know more about easystack files, you can find more explanation in easybuild documentation https://docs.easybuild.io/easystack-files/. An easystack yaml file can be as easy as having one easyconfig like https://github.com/EESSI/software-layer/blob/2023.06-software.eessi.io/easystacks/software.eessi.io/2023.06/eessi-2023.06-eb-4.9.1-001-system.yml.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants