Documentation build should be strict (especially in CI)

未关闭
#512 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
35/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
停滞
技术栈
python

调研方向

The log lines name broken anchors in pages such as tutorial/performance.md, tutorial/troubleshooting.md and tutorial/access/proxy.md, reported at INFO level. Start by finding where the docs build sets its link-validation level, then decide whether to raise it to warning or error. Done means a strict build fails on these broken anchors, and the listed links are fixed or the build passes.

由索引模型根据 Issue 内容生成。

描述

There are a number of info statements right now that are really more like errors:

INFO    -  Doc file 'blog/posts/2025/03/gpu-support-eessi.md' contains a link '../../../../site_specific_config/gpu.md#installing-full-cuda-sdk-optional', but the doc
           'site_specific_config/gpu.md' does not contain an anchor '#installing-full-cuda-sdk-optional'.
INFO    -  Doc file 'test-suite/ReFrame-configuration-file.md' contains a link '#RFM_PREFIX', but there is no such anchor on this page.
INFO    -  Doc file 'tutorial/configuration_hpc.md' contains a link '#in-memory-cache', but there is no such anchor on this page.
INFO    -  Doc file 'tutorial/performance.md' contains a link 'eessi/high-level-design.md#compat_layer', but the doc 'tutorial/eessi/high-level-design.md' does not contain
           an anchor '#compat_layer'.
INFO    -  Doc file 'tutorial/troubleshooting.md' contains a link '#cache', but there is no such anchor on this page.
INFO    -  Doc file 'tutorial/access/alternatives.md' contains a link '../configuration_hpc.md#alien-cache', but the doc 'tutorial/configuration_hpc.md' does not contain
           an anchor '#alien-cache'.
INFO    -  Doc file 'tutorial/access/proxy.md' contains a link 'client.md##minimal_configuration', but the doc 'tutorial/access/client.md' does not contain an anchor
           '##minimal_configuration'.
主要语言
Python
星标
14
派生
54
平均合并
11 小时 2 分钟
30 天内合并 PR
41

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

EESSI/docs 的其他 Issue

查看 EESSI/docs 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。