Documentation build should be strict (especially in CI)

Aperta
  • Qualcosa non va?
#512 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
35/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
build-system, documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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'.
Lingua principale
Python
Stelle
14
Fork
54
Merge medio
11h 2m
PR unite (30g)
41

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di EESSI/docs

Tutte le issue di EESSI/docs

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.