-
Notifications
You must be signed in to change notification settings - Fork 37
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update the build pipeline #386
Conversation
…uild argument to allow only building one of the directories.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Inconsistencies noticed:
- Slight stylistic differences: spacing between lines in particular. Causes some paragraphs to move to other pages.
- Styling on example email usage in Staff Crash Course
Document issues:
The only issue I found was that on some bullet points and numbers, the bullet/number is on a line above the text for that bullet/number. Non-exhaustive examples are:
- Bylaws doc: 2.4, point 5
- WCRP Announcement Criteria 1., 1.11, 2.5.4.1
- Competitor tutorial, Important Definitions
@nsilvestri could you provide an example of an unwanted page break due to the spacing between lines? For me the spacing looks the same as it does in production rn. |
Staff crash course fixed |
@dmint789 the page breaks caused by spacing are not "unwanted", just slightly different. 1-2 lines will be pushed to the next page, or vice versa. Very minor stylistic thing, just noting it as an inconsistency. |
Fixed the bullet point issue in the competitor tutorial |
Okay, now I need to update the Github actions. I think I've fixed all of the issues you found. |
Found another issue: the counters reset when there is content between two items (see the competition templates doc for an example). Currently working on fixing this. |
Fixed |
I have personally gone through every single markdown document in the repository, fixed all alignment issues and made sure they all look almost exactly the same as the original docs rendered with wkhtmltopdf. The PR is now ready for review. @nsilvestri could you please review the changes in the documents and edudoc folders? It's almost exclusively alignment fixes and changes from pure HTML to markdown/pandoc syntax in some of our old docs. My expectation is that you won't find any issues, as I tried being as thorough as possible, but it's good to have another set of eyes on the changes. @thewca/software-team could you please review the changes in the root of the repo? Namely, the changes to the assets and bin folders, the README and my newly-created Dockerfile. I will also review all of the aforementioned changes myself for good measure. |
@thewca/software-team also, I'll need someone to override the PR build test, cause it's failing due to not being up to date with these changes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for seeing through this colossal effort. LGTM on behalf of WQAC.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This review includes the technical scripts only. I have not reviewed every single md
file nor have I meticulously verified the generated PDF contents. That is left entirely up to WQAC.
@gregorbg is this good to be merged now? |
Looks like all issues are resolved now |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The technical build scripts have my approval. I did not (and will not) check the final rendered output of every single document in the new pipeline.
Sidenote: The CI error log looks like you forgot sudo
somewhere
Oh, maybe it's the apt commands. Also, does the build pipeline use the setup files from master or from this branch I'm trying to merge? I assumed the CI error would never go away until this PR is merged. |
@thewca/board can you please approve? This probably requires Board approval, because I had to edit many of the documents themselves, but the only real change is the last point in the description of this PR, but it doesn't even affect the rendered file, since the numbers themselves are ignored. I just wanted to fix the numbering in the Bylaws Markdown. I have personally checked the rendering of every single document in this repo, and everything has remained consistent, bar some very minor alignment here and there. |
@gregorbg Looks like I've answered my own question, as the PR build test has a different output after my commit now. I'll try to fix it, looks like the repos used by the github action are different from the ubuntu image repos. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved on behalf as Board regarding non-content or formatting changes to Board-sensitive documents.
@gregorbg the checks are finally passing. Can you please re-approve, cause the new commits made your approval stale. Maybe we can revisit package version locking in another issue and PR, cause this is currently blocking two of our projects. |
This is a big PR, but this was a very important update for us to make. It should improve the developer experience greatly when it comes to building the PDFs to see a preview of the documents, which was previously only really easy to do by creating a PR and waiting for the Github pipeline to do it, which always took a while and made it harder to iterate with minor adjustments. This PR does the following: