use nonstopmode to build guides PDF, link to preview #9277 #9474
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pdurbin
added this to Ready for Review ⏩
in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
via automation
This was referenced Mar 24, 2023
Closed
scolapasta
approved these changes
Mar 27, 2023
IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
automation
moved this from Ready for Review ⏩
to Ready for QA ⏩
Mar 27, 2023
kcondon
moved this from Ready for QA ⏩
to QA ✅
in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34)
automation
moved this from QA ✅
to Done 🚀
Mar 28, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
There is interest in a PDF version of the guides.
In this pull request we advertise the fact that we (as of today) are building a PDF at http://preview.guides.gdcc.io/_/downloads/en/develop/pdf/
We set expectations that this is highly experimental.
It's the same job that builds the regular HTML preview at http://preview.guides.gdcc.io/en/develop/
That is to say, the build happens when we merge a pull request.
In addition, with an eye toward improving the PDF, a Docker command has been added to the "writing docs" section of the dev guide. Again, expectations are set that these are early days.
The key to getting to getting the PDF to build at all is "nonstopmode". Perhaps some day we can remove this as we clean up the guides. I think we should do this in small chunks, which is our usual practice.
Which issue(s) this PR closes:
Special notes for your reviewer:
Not really.
Suggestions on how to test this:
Try the Docker command.
Uncomment the PDF building code at https://jenkins.dataverse.org/job/guides.dataverse.org/ and the the nonstopmode from the Docker command to see if a PDF can be build. If so, at release time, consider building the PDF and having it be available at http://guides.dataverse.org/en/latest/Dataverse.pdf (where it has lived off and on over the years).
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
No.
Is there a release notes update needed for this change?:
Yes, included.
Additional documentation:
Included.