Revise and improve mission documentation build

Aperta
#877 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
38/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
github-actions, latex

Direzione di ricerca

Inizia rieseguendo i workflow della documentazione dai tag v7.0.0 draco o dalle PR referenziate 871–873, quindi esamina le issue 875 e 2676 e le PR 876 e 2677. Il lavoro è completato quando la documentazione viene compilata correttamente e produce PDF gestibili e ben delimitati, senza contenuti duplicati, separando opportunamente i documenti dei moduli.

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

Descrizione

bug docs

Checklist (Please check before submitting)

  • I reviewed the Contributing Guide.
  • I performed a cursory search to see if the bug report is relevant, not redundant, nor in conflict with other tickets.

Describe the bug

In the following issues / PRs, we identified a failing mission-doc build:

The error seemed to be caused because the output mission doc PDF was far too large.
In those PRs, we disabled that workflow (to prevent the noise in the pipeline).

This issue is a follow-on to work the larger effort to fix the mission documentation.

We were generating the following:

  1. cFE User Guide
  2. OSAL API Guide
  3. Combined Mission Documentation

The third seemed to be a combo of the first two, plus additional documentation from each app in the build.
Instead, perhaps we should update the pipeline to generate a PDF for each of the modules separately, rather than combining them together. That way, each of the resulting files is more likely to stay under the size limits of pandoc/latex.

To Reproduce

  • Rerun the workflows from the v7.0.0 draco tags, or one of PRs that started experiencing these errors (listed below in additional context)

Expected behavior

  1. Documentation Builds pass
  2. Documents are manageable (not too large, well-scoped, no duplicates)

Code snips
N/A

System observed on:

  • Ubuntu / GitHub Runner containers

Additional context

The failing mission doc builds started with the v7.0.0 draco updates:

Reporter Info
Keegan Moore / NASA GSFC

Lingua principale
C
Stelle
1.6k
Fork
421
Merge medio
1g 42m
PR unite (30g)
12

Preparare l'ambiente

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 nasa/cFS

Tutte le issue di nasa/cFS

Issue simili

Altre issue su C

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.