- Each chapter is a branch, with an associated PR
- Each PR corresponds to a chapter number, e.g. #1 is the PR for the Chapter-1 branch
- Co-Authors push to Chapter branches which will update PR's
- Co-Authors, Reviewers and Proof Readers use Commit Notes (on the Files Changes tab) to add inline comments to the PR which can be addressed by authors
- Commits are squashed at each draft stage, and final commit named according to state (first-draft, second-draft, complete)
- Once a chapter is complete, we check in a PDF, merge the branch to master and lock the PR.
- Any changes after this step should be avoided if at all possible, since changes after the Complete stage should be rare, any that arise will be direct commits to master.
No other issues or PR's should be opened, all communication should happen in the PR's.
The following labels can be applied to PR's to communicate the status of a chapter:
Some labels can be applied in parallel. The addressing-comments label should be applied alongside the relevant review label, no need to apply if addressing co-author comments.
Use hyperpdf to create a PDF from the markdown
npm install -g hyperpdfGenerate a chapter with hyperpdf <markdown-file> <pdf-file>,
for example:
hyperpdf 1-Writing-Modules/content.md 1-Writing-Modules.pdf- The PDF is generated from markdown rendered as HTML. We need a CSS file that applies the Cookbook brand colours, fonts, etc to this HTML.