Documentation build should be strict (especially in CI)

Ouverte
#512 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
35/100
Type d'issue
Bug
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
python

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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'.
Langage dominant
Python
Étoiles
14
Forks
54
Merge moyen
11 h 2 min
PR mergées (30 j)
41

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de EESSI/docs

Toutes les issues de EESSI/docs

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.