Revise and improve mission documentation build
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
- Ambito
- build-system, ci-cd, documentation
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
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:
- https://github.com/nasa/cFS/issues/875
- https://github.com/nasa/cFS/pull/876
- https://github.com/nasa/cFE/issues/2676
- https://github.com/nasa/cFE/pull/2677
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:
- cFE User Guide
- OSAL API Guide
- 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
- Documentation Builds pass
- 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:
- https://github.com/nasa/cFS/pull/871
- https://github.com/nasa/cFS/pull/872
- https://github.com/nasa/cFS/pull/873
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
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di nasa/cFS
-
[SECURITY] Off-by-one bounds check in SBN HKPeerCmd/HKNetCmd allows access to invalid net/peer slotsForse già presa @0x000NULL l’ha presa 38 giorni fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 92/100
I maintainer di solito rispondono entro 1 giorno
-
Update Workflow READMEApertacontinuous-integration
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
[SECURITY] Missing length validation for CFE_EVS_SEND_HK_MID in EVS ProcessCommandPacketForse già presa @linerfan5114 l’ha presa 204 giorni fa. Apertabug
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
I maintainer di solito rispondono entro 1 giorno
-
[SECURITY] Missing length validation for CFE_ES_SEND_HK_MID in ES TaskPipeForse già presa @linerfan5114 l’ha presa 204 giorni fa. Apertabug
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
python-pillow/Pillow#10590 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
CCExtractor/ccextractor#2478 ·
I maintainer di solito rispondono entro 7 giorni
-
增加kmod-nft-queueAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 80/100
ESPresense/ESPresense#2680 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
OpenPrinting/cups#1828 · 4 commenti ·
I maintainer di solito rispondono entro 1 giorno