Simplify documentation

Đang mở
  • Có gì không ổn?
#123 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
15/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Lĩnh vực
documentation

Hướng nghiên cứu

The issue proposes restructuring the EESSI docs into three entry points (using EESSI by persona, contributing, background) and asks for less prominent pages to rank lower in search. It names no file or test, so start by finding the docs navigation config and the page linked as /docs/adding_software/opening_pr/. Done would need a maintainer-agreed structure; the issue has had no comment in about 900 days and the decision is still open.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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?

Ngôn ngữ chính
Python
Star
14
Fork
54
Merge trung bình
11 giờ 2 phút
Pull request đã merge (30 ngày)
41

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của EESSI/docs

Tất cả issue của EESSI/docs

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.