-
Notifications
You must be signed in to change notification settings - Fork 324
Description
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:
- Failing Build cFS documents / Build Documentation (mission-doc) action #875
- Fix #875, Disable build-mission-doc workflow and remove README link #876
- Failing mission-doc build documentation workflow cFE#2676
- Fix #2676, Specify pandoc memory to fix mission-doc build cFE#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:
- Updating bundle to include all open source apps/tools, part 1 #871
- Draco integration candidate, part 2 #872
- Fix #469, Additional bundle updates for Draco open source release #873
Reporter Info
Keegan Moore / NASA GSFC