Conversation
This was
linked to
issues
Dec 4, 2024
Closed
egpbos
approved these changes
Dec 4, 2024
Collaborator
egpbos
left a comment
There was a problem hiding this comment.
Great PR, thank you for fixing this process and making the output much better as well! I have just one suggestion below, I'll just go ahead and commit that and then I think we can merge that. I have a few follow-up issues that I will create as well:
- Add headers to all chapters (you added one to the Technology overview page, others should have it as well).
- The PDF should have the version somewhere, preferably on the cover, but colofon or something is fine too.
- Your point: "Pushing to Zenodo is conditional (it will not be done when the workflow is triggered manually, in that case, it only generates the PDF, for testing purposes). This could be updated to push to sanbox.zenodo.org, but that should be a separate issue."
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - uses: actions/checkout@v4 |
Collaborator
There was a problem hiding this comment.
Great that you also updated the action versions (also for setup-node below)!
This was referenced Dec 4, 2024
This was referenced Dec 4, 2024
This file contains hidden or 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
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.
Changes in this PR
I updated the
page.ymlGitHub action to generate PDFs correctly, namely:docsify-pdf-converter(outdated) todocker-docsify-pdf. The new PDF generator creates a cleaner PDF that includes the TOC by default.sanbox.zenodo.org, but that should be a separate issue.Smaller changes:
technology_overviewpage as it was missing (noticeable when generating a PDF).Figuresnot to clutter the root dir, but this can be changed.The PR resolves issues:
#270 (PDF is generated, Upload to Zenodo should be tested at the release)
#368 (TOC is now included
#369 (while the formatting is not perfect, it is much better, e.g., each section starts on a separate page, table formatting does not break, etc.)
Checklist
SIGNIFICANT changes / additions, e.g. new chapters
ALL contributions
python3 -m http.server 4000and confirmed they work correctly.docker run --init -it -v `pwd`:/docs lycheeverse/lychee /docs --config=docs/lychee.toml, at least for the files I changed.CITATION.cfffile.