Simplify documentation
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 15/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
调研方向
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.
由索引模型根据 Issue 内容生成。
描述
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:
-
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 -
contributing to EESSI : https://www.eessi.io/docs/adding_software/opening_pr/
-
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?
- 主要语言
- Python
- 星标
- 14
- 派生
- 54
- 平均合并
- 11 小时 2 分钟
- 30 天内合并 PR
- 41
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
EESSI/docs 的其他 Issue
-
难度 1/5 1 小时以内 新手友好度 88/100
维护者通常 1 天内回复
-
难度 1/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 70/100
维护者通常 1 天内回复
-
good first issue
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
难度 2/5 半天 新手友好度 62/100
维护者通常 1 天内回复
相似的 Issue
-
ChatBedrockConverse changes the keys of JSON tool results to camelCase (`order_id` becomes `orderId`)可能已有人在做 @geyazheng 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
langchain-ai/langchain-aws#1469 ·
维护者通常 1 天内回复
-
b4b usability
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复
-
fix(schedule): align list_tasks since cursor filter boundary from strict > to >=可能已有人在做 @bfs2021 今天认领。 未关闭agent-ready bug p2 schedule
难度 2/5 1-3 小时 新手友好度 83/100
allenporter/supernote#540 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 76/100
frazane/scoringrules#164 ·
维护者通常 1 天内回复
-
The docs build fails: ecc's live inventory dropped the ecc.ecc names btclib's pinned ecc uses可能已有人在做 @fametrano 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
btclib-org/btclib#2968 ·
维护者通常 1 天内回复