Documentation build should be strict (especially in CI)

オープン
#512 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
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分
マージ済み PR(30日)
41

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

EESSI/docs のほかの issue

EESSI/docs の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。